Programmer Guide/Command Reference/STXCONSTANTS - Revision history

Christian: /* Examples */

2014-04-29T20:22:12Z

Examples

← Older revision		Revision as of 22:22, 29 April 2014
Line 15:		Line 15:

	<var>#nConstants</var> := STXCONSTANTS * <var>item7</var>		<var>#nConstants</var> := STXCONSTANTS * <var>item7</var>
	~~Stores~~ all constants supported by the <code>VAR STXCONSTANTS</code> command in the table <var>item7</var>, and returns their the number, which, in turn, gets assigned to <var>#nConstants</var>.		{{STX\|caps}} stores all constants supported by the <code>VAR STXCONSTANTS</code> command in the table <var>item7</var>, and returns their the number, which, in turn, gets assigned to <var>#nConstants</var>.

	<var>#nColors</var> := STXCONSTANTS COLORS <var>colorTable</var>		<var>#nColors</var> := STXCONSTANTS COLORS <var>colorTable</var>
	~~Adds~~ all supported color constants to the table <var>colorTable</var> and stores the number of entries in <var>#nColors</var>.		{{STx\|caps}} stores all supported color constants in the table <var>colorTable</var> and stores the number of entries in <var>#nColors</var>.

Christian at 20:20, 29 April 2014

2014-04-29T20:20:36Z

← Older revision		Revision as of 22:20, 29 April 2014
Line 7:		Line 7:
	If no <var>table</var> argument is supplied, the command will return the respective list as a string containing the names of all constants, separated by blanks.		If no <var>table</var> argument is supplied, the command will return the respective list as a string containing the names of all constants, separated by blanks.

	If you do not know what constants {{STX}} supports, i.e., what values you may supply for <var>constanttype</var> (we don't know this either!), the second form of the <code>STXCONSTANTS</code> command comes in handy: If you supply the command only with an asterisk for its arguments, the command will return a list of constant types, cleanly separated by blanks. If you add the <var>table</var> argument, which must be a table, the list of constant types will be stored in the table, one entry per constant (any old content of the table will get lost). In the latter case, the command returns the number of the supported constants. Now isn't ~~all that~~ gorgeous!		If you do not know what constants {{STX}} supports, i.e., what values you may supply for <var>constanttype</var> (we don't know this either!), the second form of the <code>STXCONSTANTS</code> command comes in handy: If you supply the command only with an asterisk for its arguments, the command will return a list of constant types, cleanly separated by blanks. If you add the <var>table</var> argument, which must be a table, the list of constant types will be stored in the table, one entry per constant (any old content of the table will get lost). In the latter case, the command returns the number of the supported constants. Now isn't {{Stx}} gorgeous!

	== Examples ==		== Examples ==

Christian at 20:19, 29 April 2014

2014-04-29T20:19:52Z

← Older revision		Revision as of 22:19, 29 April 2014
Line 7:		Line 7:
	If no <var>table</var> argument is supplied, the command will return the respective list as a string containing the names of all constants, separated by blanks.		If no <var>table</var> argument is supplied, the command will return the respective list as a string containing the names of all constants, separated by blanks.

	If you do not know what constants {{STX}} supports, i.e., what values you may supply for <var>constanttype</var> (we don't know this either!), the second form of the <code>STXCONSTANTS</code> ~~comnmand~~ comes in handy: If you supply the command only with an asterisk for its arguments, the command will return a list of constant types, cleanly separated by blanks. If you add the <var>table</var> argument, which must be a table, the list of constant types will be stored in the table, one entry per constant (any old content of the table will get lost). In the latter case, the command returns the number of the supported constants. Now isn't all that gorgeous!		If you do not know what constants {{STX}} supports, i.e., what values you may supply for <var>constanttype</var> (we don't know this either!), the second form of the <code>STXCONSTANTS</code> command comes in handy: If you supply the command only with an asterisk for its arguments, the command will return a list of constant types, cleanly separated by blanks. If you add the <var>table</var> argument, which must be a table, the list of constant types will be stored in the table, one entry per constant (any old content of the table will get lost). In the latter case, the command returns the number of the supported constants. Now isn't all that gorgeous!

	== Examples ==		== Examples ==

Christian at 20:19, 29 April 2014

2014-04-29T20:19:13Z

← Older revision		Revision as of 22:19, 29 April 2014
Line 3:		Line 3:
	<var>var</var> := STXCONSTANTS * [ <var>table</var> ]		<var>var</var> := STXCONSTANTS * [ <var>table</var> ]

	The <code>STXCONSTANT</code> command returns the list of constants of a certain type, <var>constanttype</var> (see below). If the <var>table</~~tab~~> argument is present, then it must specify an {{STx}} table. In this case, the table will be cleared, and the respective list of constants will be stored in the table, one entry per constant. In this case, the command will return the total number of constants returned.		The <code>STXCONSTANT</code> command returns the list of constants of a certain type, <var>constanttype</var> (see below). If the <var>table</var> argument is present, then it must specify an {{STx}} table. In this case, the table will be cleared, and the respective list of constants will be stored in the table, one entry per constant. In this case, the command will return the total number of constants returned.

	If no <var>table</var> argument is supplied, the command will return the respective list as a string containing the names of all constants, separated by blanks.		If no <var>table</var> argument is supplied, the command will return the respective list as a string containing the names of all constants, separated by blanks.

Christian at 20:18, 29 April 2014

2014-04-29T20:18:19Z

← Older revision		Revision as of 22:18, 29 April 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	<var>var</var> := STXCONSTANTS * \| <var>~~keyword~~</var> <var>table</var>		<var>var</var> := STXCONSTANTS <var>constanttype</var> [ <var>table</var> ]
			<var>var</var> := STXCONSTANTS * [ <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 of a certain type, <var>constanttype</var> (see below). If the <var>table</tab> argument is present, then it must specify an {{STx}} table. In this case, the table will be cleared, and the respective list of constants will be stored in the table, one entry per constant. In this case, the command will return the total number of constants returned.

			If no <var>table</var> argument is supplied, the command will return the respective list as a string containing the names of all constants, separated by blanks.

			If you do not know what constants {{STX}} supports, i.e., what values you may supply for <var>constanttype</var> (we don't know this either!), the second form of the <code>STXCONSTANTS</code> comnmand comes in handy: If you supply the command only with an asterisk for its arguments, the command will return a list of constant types, cleanly separated by blanks. If you add the <var>table</var> argument, which must be a table, the list of constant types will be stored in the table, one entry per constant (any old content of the table will get lost). In the latter case, the command returns the number of the supported constants. Now isn't all that gorgeous!

	== Examples ==		== Examples ==

	#stxConstants := STXCONSTANTS *		<var>#stxConstants</var> := STXCONSTANTS *
	~~Returns~~ a blank separated list of constants supported by the <code>VAR STXCONSTANTS</code> command		{{Stx\|caps}} will return a blank-separated list of the constants supported. In turn, each word in this list is valid for the <var>constanttype</var> argument to the <code>VAR STXCONSTANTS</code> command.

	#nConstants := STXCONSTANTS * ~~table~~		<var>#nConstants</var> := STXCONSTANTS * <var>item7</var>
	~~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~~>.		Stores all constants supported by the <code>VAR STXCONSTANTS</code> command in the table <var>item7</var>, and returns their the number, which, in turn, gets assigned to <var>#nConstants</var>.

	#nColors := STXCONSTANTS COLORS colorTable		<var>#nColors</var> := STXCONSTANTS COLORS <var>colorTable</var>
	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 <var>colorTable</var> and stores the number of entries in <var>#nColors</var>.

Christian at 20:05, 29 April 2014

2014-04-29T20:05:10Z

← Older revision		Revision as of 22:05, 29 April 2014
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 *

Christian at 20:04, 29 April 2014

2014-04-29T20:04:50Z

← Older revision		Revision as of 22:04, 29 April 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	==STXCONSTANTS==		<var>var</var> := STXCONSTANTS * \| <var>keyword</var> <var>table</var>

	~~<code><var>var</var> := STXCONSTANTS *\|<var>keyword</var> <var>table</var></code>~~		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 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:

	~~<pre>~~		#stxConstants := STXCONSTANTS *
	#stxConstants := STXCONSTANTS *
	~~</pre>~~
	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

	~~<pre>~~		#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>.
	~~</pre>~~
	Adds all constants supported by the <code>VAR STXCONSTANTS</code> command to the <code>table</code> and ~~returns~~ the number of entries to the variable <code>#nConstants</code>.

	~~<pre>~~		#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>.
	~~</pre>~~
	Adds all supported color constants to the table <code>colorTable</code> and ~~returns~~ the number of entries to <code>#nColors</code>.

Christian: Text replace - "S_TOOLS-STx" to "{{STX}}"

2011-04-05T15:56:26Z

Text replace - "S_TOOLS-STx" to "{{STX}}"

← Older revision		Revision as of 17:56, 5 April 2011
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 ~~S_TOOLS-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.		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:

Admin: 1 revision: Initial import

2010-11-18T16:31:34Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==STXCONSTANTS==

<code><var>var</var> := STXCONSTANTS *|<var>keyword</var> <var>table</var></code>

The <code>STXCONSTANT</code> command returns the list of constants supported in S_TOOLS-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:

<pre>
#stxConstants := STXCONSTANTS *
</pre>
Returns a blank separated list of constants supported by the <code>VAR STXCONSTANTS</code> command

<pre>
#nConstants := STXCONSTANTS * table
</pre>
Adds all constants supported by the <code>VAR STXCONSTANTS</code> command to the <code>table</code> and returns the number of entries to the variable <code>#nConstants</code>.

<pre>
#nColors := STXCONSTANTS COLORS colorTable
</pre>
Adds all supported color constants to the table <code>colorTable</code> and returns the number of entries to <code>#nColors</code>.