Difference between revisions of "Programmer Guide/Command Reference/STXCONSTANTS"

From STX Wiki
Jump to navigation Jump to search
Line 4: Line 4:
 
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 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.
  
Examples:
+
== Examples ==
  
 
  #stxConstants := STXCONSTANTS *
 
  #stxConstants := STXCONSTANTS *

Revision as of 22:05, 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.