Programmer Guide/Command Reference/STXCONSTANTS: Difference between revisions
From STX Wiki
Jump to navigationJump to search
m (1 revision: Initial import) |
m (Text replace - "S_TOOLS-STx" to "{{STX}}") |
||
| Line 4: | Line 4: | ||
<code><var>var</var> := STXCONSTANTS *|<var>keyword</var> <var>table</var></code> | <code><var>var</var> := STXCONSTANTS *|<var>keyword</var> <var>table</var></code> | ||
The <code>STXCONSTANT</code> command returns the list of constants supported in | The <code>STXCONSTANT</code> command returns the list of constants supported in {{STX}} dependant on the <var>keyword</var>. If a <var>table</var> is passed, the <var>table</var> is emptied, a new entry is added for each constant and the number of entries is returned to <var>var</var>. If no table is passed, a space delimited concatenated string of the constants is returned. | ||
Examples: | Examples: | ||
Revision as of 17:56, 5 April 2011
STXCONSTANTS
var := STXCONSTANTS *|keyword table
The STXCONSTANT command returns the list of constants supported in STx dependant on the keyword. If a table is passed, the table is emptied, a new entry is added for each constant and the number of entries is returned to var. 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 returns the number of entries to the variable #nConstants.
#nColors := STXCONSTANTS COLORS colorTable
Adds all supported color constants to the table colorTable and returns the number of entries to #nColors.
