Programmer Guide/Command Reference: Difference between revisions

From STX Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(41 intermediate revisions by 3 users not shown)
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}}}}
The {{STx}} command reference documents all the commands available in the {{STX}} macro language. This is with the notable exception of the {{Stx}} 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}} command generates both a ''result value'' (the return value of the command) and a ''completion code'', the latter indicating success or failure of the command. The completion code is stored in the shell variables <var>RC</var>. This is either 0, indicating success, or a numerical error or warning code. The shell variable <var>EMSG</var> will contain a textual error message according to value of <var>RC</var>.


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.
:* You should make it a habit to always end the list of options with the [[Programmer_Guide/Command_Reference_Options/-|"end of options" option, <code>/-</code>]] (q.v.) because, otherwise, you will get into trouble when command arguments start with a slash.
:*Some commands uses the completion code also as return value.
:*Most commands overwrite the variables <var>RC</var> and <var>EMSG</var>. There are a few commands, though, which touch <var>RC</var> and <var>EMSG</var> only if an execution error occours. The most prominent commands in the latter group are [[/IF|IF]] and [[/GOTO|GOTO]] and, actually, most other control commands.
:*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>  
:* Some commands return the completion code also as their result value.
:* In contrast to commands, ''macros'' store their return value (generated with the [[/EXIT|EXIT]] command) in the variable <var>RESULT</var>, meaning that macro calls do not affect the variables <var>RC</var> and <var>EMSG</var>, unless they use commands!


== Introductions ==
;See also: [[Programmer_Guide/Introduction|Introduction]], [[Programmer_Guide/Shell_Items|shell items]]


== {{STx|caps}} commands (alphabetical list) ==
<splist
<splist
parent=Programmer_Guide/Concepts
parent=Programmer_Guide/Command_Reference
sort=asc
sortby=title
showpath=no
liststyle=unordered
kidsonly=yes
></splist>
 
== Commands (alphabetical list) ==
<splist
parent=
sort=asc
sort=asc
sortby=title
sortby=title
Line 29: Line 22:
></splist>
></splist>


== Global Options ==
== Common {{STX}} options ==


<splist
{{Programmer_Guide/Command_Reference_Options}}
parent=Programmer_Guide/Command_Reference_Options
sort=asc
sortby=title
showpath=no
liststyle=unordered
kidsonly=yes
></splist>

Latest revision as of 14:23, 14 August 2019

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

Each STx command generates both a result value (the return value of the command) and a completion code, the latter indicating success or failure of the command. The completion code is stored in the shell variables RC. This is either 0, indicating success, or a numerical error or warning code. The shell variable EMSG will contain a textual error message according to value of RC.

Notes
  • You should make it a habit to always end the list of options with the "end of options" option, /- (q.v.) because, otherwise, you will get into trouble when command arguments start with a slash.
  • Most commands overwrite the variables RC and EMSG. There are a few commands, though, which touch RC and EMSG only if an execution error occours. The most prominent commands in the latter group are IF and GOTO and, actually, most other control commands.
  • Some commands return the completion code also as their result value.
  • In contrast to commands, macros store their return value (generated with the EXIT command) in the variable RESULT, meaning that macro calls do not affect the variables RC and EMSG, unless they use commands!
See also
Introduction, shell items

STx 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

Common STx options

Template:Programmer Guide/Command Reference Options

Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Command_Reference&oldid=10481"

Navigation menu

Personal tools