Programmer Guide/Command Reference: Difference between revisions
From STX Wiki
Jump to navigationJump to search
No edit summary |
|||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}}__TOC__ | ||
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 [[Programmer_Guide/Shell_Items|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 <code>RC</code> (numerical error or warning code, 0 = success) and <code>EMSG</code> (error msg according to value of <code>RC</code>). | 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 <code>RC</code> (numerical error or warning code, 0 = success) and <code>EMSG</code> (error msg according to value of <code>RC</code>). | ||
Notes: | ;Notes: | ||
:*The most commands overwrites the variables <code>RC</code> and <code>EMSG</code> always, but some commands (like [[/IF|IF]], [[/GOTO|GOTO]] and most other control commands) overwrites <code>RC/EMSG</code> only if an execution error occours. | :*The most commands overwrites the variables <code>RC</code> and <code>EMSG</code> always, but some commands (like [[/IF|IF]], [[/GOTO|GOTO]] and most other control commands) overwrites <code>RC/EMSG</code> only if an execution error occours. | ||
:*Some commands uses the completion code also as return value. | :*Some commands uses the completion code also as return value. | ||
:*In contrast to commands, macros store their return value (generated with the [[/EXIT|EXIT]] command) in the variable <code>RESULT</code> and do not effect the variables <code>RC/EMSG</code> | :*In contrast to commands, macros store their return value (generated with the [[/EXIT|EXIT]] command) in the variable <code>RESULT</code> and do not effect the variables <code>RC/EMSG</code> | ||
;See also: [[Programmer_Guide/Introduction]], [[Programmer_Guide/Shell_Items]] | |||
== Commands (alphabetical list) == | == Commands (alphabetical list) == | ||
Revision as of 12:19, 18 April 2011
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
RCandEMSGalways, but some commands (like IF, GOTO and most other control commands) overwritesRC/EMSGonly 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
RESULTand do not effect the variablesRC/EMSG
- The most commands overwrites the variables
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
