Programmer Guide/Command Reference: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (Text replace - "Command_Reference_Intro" to "Concepts") |
No edit summary |
||
Line 1: | Line 1: | ||
{{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]]. | {{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]]. | ||
Note that | Note that 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: | |||
:*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. | |||
:* | |||
See [[Programmer Guide/Shell_Environment|Shell Environment]] for more details. This is in contrast to all [[Programmer_Guide/Command_Reference/MACRO|MACRO]] commands which store their exit value in the variable <code>result</code>. | |||
== Introductions == | == Introductions == |
Revision as of 18:33, 13 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.
Note that 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
andEMSG
always, but some commands (like IF, [[Programmer Guide/GOTO|GOTO] and most other control commands) overwritesRC/EMSG
only if an execution error occours. - Some commands uses the completion code also as return value.
- The most commands overwrites the variables
See Shell Environment for more details. This is in contrast to all MACRO commands which store their exit value in the variable result
.
Introductions
Commands (alphabetical list)
sort=asc has no subpages to list.