Command Reference

The Command Reference documents all the commands available in the STx macro language. This is with the notable exception of the shell item commands, which are documented in the chapter Shell Items.

Each STx commands generates a result value (the return value of the command) and a completion code (to indicate success or error). The completion code is stored in the shell variables RC (numerical error or warning code, 0 = success) and EMSG (error msg according to value of RC).

Notes

• The most commands overwrites the variables RC and EMSG always, but some commands (like IF, GOTO and most other control commands) overwrites RC/EMSG only if an execution error occours.
• Some commands uses the completion code also as return value.
• In contrast to commands, macros store their return value (generated with the EXIT command) in the variable RESULT and do not effect the variables RC/EMSG

See also

Introduction, shell items

Commands (alphabetical list)

ARG · ATTRIBUTES · BREAK · CHECKIT · COND · CONTINUE · DELETE · DISPATCH · DO · DRIVE · ELSE · EMSG · END · ENV · EVAL · EVALCHECK · EXIT · FIND · FOR · FOREVER · FORMAT · GOSUB · GOSUBX · GOTO · IF · IFNOT · INT · INTCHECK · INTERPRET · IREF · KEYWORD · LENGTH · LINELENGTH · LIST · LOAD · LOGMSG · LOWER · MACRO · MACROX · MESSAGE · NAME · NEW · NUM · NUMCHECK · PARSECELLMESSAGE · POSITION · PRINTDIALOG · PRINTSETTINGS · PWD · QUERY · QUOTE · READ · REVERSE · SEGMENT · SET · SFTRUNCATE · SHELL · STRCHR · STXCONSTANTS · SUBSTR · SYSINFO · SYSTEM · TAGS · TGET · TIME · TOKEN · TRANSLATE · TRIM · TSET · UNIQUE · UNLOAD · UPPER · WHILE · WORD · WORDS · WRITE · WRITELOG

Global Options

• -
• Silent
• Variables