Programmer Guide/Command Reference/STXCONSTANTS: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (Text replace - "S_TOOLS-STx" to "{{STX}}") |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{DISPLAYTITLE:{{SUBPAGENAME}}}} | ||
<var>var</var> := STXCONSTANTS * | <var>keyword</var> <var>table</var> | |||
The <code>STXCONSTANT</code> command returns the list of constants supported in {{STX}} dependant on the <var>keyword</var>. If argument <var>table</var> is passed, and is a table, the respective table is emptied, a new entry is added for each constant, and the number of entries is returned. If no table is passed, a space delimited concatenated string of the constants is returned. | |||
The <code>STXCONSTANT</code> command returns the list of constants supported in {{STX}} dependant on the <var>keyword</var>. If | |||
Examples: | Examples: | ||
#stxConstants := STXCONSTANTS * | |||
#stxConstants := STXCONSTANTS * | |||
Returns a blank separated list of constants supported by the <code>VAR STXCONSTANTS</code> command | Returns a blank separated list of constants supported by the <code>VAR STXCONSTANTS</code> command | ||
#nConstants := STXCONSTANTS * table | |||
#nConstants := STXCONSTANTS * table | Adds all constants supported by the <code>VAR STXCONSTANTS</code> command to the <code>table</code> and stores the number of entries in the variable <code>#nConstants</code>. | ||
Adds all constants supported by the <code>VAR STXCONSTANTS</code> command to the <code>table</code> and | |||
#nColors := STXCONSTANTS COLORS colorTable | |||
#nColors := STXCONSTANTS COLORS colorTable | Adds all supported color constants to the table <code>colorTable</code> and stores the number of entries in <code>#nColors</code>. | ||
Adds all supported color constants to the table <code>colorTable</code> and | |||
Revision as of 21:04, 29 April 2014
var := STXCONSTANTS * | keyword table
The STXCONSTANT command returns the list of constants supported in STx dependant on the keyword. If argument table is passed, and is a table, the respective table is emptied, a new entry is added for each constant, and the number of entries is returned. If no table is passed, a space delimited concatenated string of the constants is returned.
Examples:
#stxConstants := STXCONSTANTS *
Returns a blank separated list of constants supported by the VAR STXCONSTANTS command
#nConstants := STXCONSTANTS * table
Adds all constants supported by the VAR STXCONSTANTS command to the table and stores the number of entries in the variable #nConstants.
#nColors := STXCONSTANTS COLORS colorTable
Adds all supported color constants to the table colorTable and stores the number of entries in #nColors.
