Programmer Guide/Command Reference: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
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 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>  
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 19:40, 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.

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, [[Programmer Guide/GOTO|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 [[Programmer Guide/EXIT|EXIT command) in the variable RESULT and do not effect the variables RC/EMSG

Introductions

Commands (alphabetical list)

sort=asc has no subpages to list.

Global Options

Navigation menu

Personal tools