Programmer Guide/Command Reference/TOKEN - Revision history

Jw at 09:27, 4 March 2016

2016-03-04T09:27:04Z

← Older revision		Revision as of 11:27, 4 March 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{PG_StringCommands}}
	<var>var</var> := TOKEN [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /D=<var>delimiter</var> ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>index</var> <var>string</var>…		<var>var</var> := TOKEN [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /D=<var>delimiter</var> ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>index</var> <var>string</var>…

Christian at 14:10, 2 May 2014

2014-05-02T14:10:28Z

← Older revision		Revision as of 16:10, 2 May 2014
Line 9:		Line 9:

	;<var>index</var>		;<var>index</var>
	:The zero-based index of the token to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1), <var>nWords</var> ~~meaning~~ the number tokens available in the <var>string</var> argument.		:The zero-based index of the token to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1, <var>nWords</var> being the number tokens available in the <var>string</var> argument).

	;<var>string</var>…		;<var>string</var>…

Christian at 14:09, 2 May 2014

2014-05-02T14:09:59Z

← Older revision		Revision as of 16:09, 2 May 2014
Line 9:		Line 9:

	;<var>index</var>		;<var>index</var>
	:The zero-based index of the token to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).		:The zero-based index of the token to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1), <var>nWords</var> meaning the number tokens available in the <var>string</var> argument.

	;<var>string</var>…		;<var>string</var>…

Christian at 13:48, 2 May 2014

2014-05-02T13:48:48Z

← Older revision		Revision as of 15:48, 2 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	<var>var</var> := TOKEN [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /D=<var>delimiter</var> ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>index</var> <var>string~~<sub>1</sub></var> <var>string<sub>2</sub>~~</var>		<var>var</var> := TOKEN [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /D=<var>delimiter</var> ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>index</var> <var>string</var>…

	This command, similar to the <code>[[Programmer Guide/Command Reference/WORD\|WORD]]</code> command, tokenises a string ~~using blanks, or~~ the ~~specified~~ delimiter.		This command, similar to the <code>[[Programmer Guide/Command Reference/WORD\|WORD]]</code> command, tokenises a string into words separated by a delimiter specified with the <code>/delimiter</code> option.

	The command returns the respective token or an empty string if <var>index</var> is not a number or if it is outside the range 0…<var>nTokens</var>-1		The command returns the respective token or an empty string if <var>index</var> is not a number or if it is outside the range 0…<var>nTokens</var>-1, <var>nTokens</var> indicating the number of available tokens in the <var>string</var> argument.

	When using <code>TOKEN</code>, do not forget to use the [[Programmer_Guide/Command_Reference_Options/-\|<code>/-</code>]] option before the first argument (and after any other options). Without the [[Programmer_Guide/Command_Reference_Options/-\|<code>/-</code>]] option, any argument starting with a slash will be mistaken for an option.		When using <code>TOKEN</code>, do not forget to use the [[Programmer_Guide/Command_Reference_Options/-\|<code>/-</code>]] option before the first argument (and after any other options). Without the [[Programmer_Guide/Command_Reference_Options/-\|<code>/-</code>]] option, any argument starting with a slash will be mistaken for an option.
Line 11:		Line 11:
	:The zero-based index of the token to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).		:The zero-based index of the token to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).

	;<var>string~~<sub>1</sub></var> <var>string<sub>2</sub>~~</var>		;<var>string</var>…
	:A string to tokenise.		:A string to tokenise. If you supply more than one string, they will still be considered one string, following {{STx}} rules for argument concatenation.

	;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]]</code>		;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]]</code>

Christian at 13:23, 2 May 2014

2014-05-02T13:23:37Z

← Older revision		Revision as of 15:23, 2 May 2014
Line 17:		Line 17:
	:If set, the function sets the return code on failure. Otherwise, it sets the return code to 0, even if the parameters are invalid.		:If set, the function sets the return code on failure. Otherwise, it sets the return code to 0, even if the parameters are invalid.

	;~~<code>/Delimiter</code>~~		;<code>/Delimiter=<var>delimiter</var></code>
	~~:Set the delimiter using the following format:~~		:Set the delimiter character. The default delimiter is a blank character.
	:<code>/Delimiter=~~</code>~~<var>delimiter</var>~~, e.g. <code>#var := token /D=, /- $#index $#wordlist~~</code>
	:The default delimiter is a blank.

	== Example ==		== Example ==

Christian at 13:22, 2 May 2014

2014-05-02T13:22:49Z

← Older revision		Revision as of 15:22, 2 May 2014
Line 9:		Line 9:

	;<var>index</var>		;<var>index</var>
	:The zero-based index of the ~~word~~ to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).		:The zero-based index of the token to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).

	;<var>string<sub>1</sub></var> <var>string<sub>2</sub></var>		;<var>string<sub>1</sub></var> <var>string<sub>2</sub></var>

Christian at 13:22, 2 May 2014

2014-05-02T13:22:04Z

← Older revision		Revision as of 15:22, 2 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	<var>var</var> := TOKEN [ [[Command_Reference_Options/Silent\|/Silent]] ] [ /D=<var>delimiter</var> ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>index</var> <var>string<sub>1</sub></var> <var>string<sub>2</sub></var>		<var>var</var> := TOKEN [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /D=<var>delimiter</var> ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>index</var> <var>string<sub>1</sub></var> <var>string<sub>2</sub></var>

	This command, similar to the <code>[[Programmer Guide/Command Reference/WORD\|WORD]]</code> command, tokenises a string using blanks, or the specified delimiter.		This command, similar to the <code>[[Programmer Guide/Command Reference/WORD\|WORD]]</code> command, tokenises a string using blanks, or the specified delimiter.
Line 14:		Line 14:
	:A string to tokenise.		:A string to tokenise.

	;<code>[[Command_Reference_Options/Silent\|/Silent]]</code>		;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]]</code>
	:If set, the function sets the return code on failure. Otherwise, it sets the return code to 0, even if the parameters are invalid.		:If set, the function sets the return code on failure. Otherwise, it sets the return code to 0, even if the parameters are invalid.

Christian at 13:21, 2 May 2014

2014-05-02T13:21:34Z

← Older revision		Revision as of 15:21, 2 May 2014
Line 11:		Line 11:
	:The zero-based index of the word to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).		:The zero-based index of the word to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).

	;<var>string<sub>1</sub></var> <var>string<~~var~~>2</~~var~~></var>		;<var>string<sub>1</sub></var> <var>string<sub>2</sub></var>
	:A string to tokenise.		:A string to tokenise.

Christian at 13:21, 2 May 2014

2014-05-02T13:21:10Z

← Older revision		Revision as of 15:21, 2 May 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	==TOKEN==		<var>var</var> := TOKEN [ [[Command_Reference_Options/Silent\|/Silent]] ] [ /D=<var>delimiter</var> ] [[Programmer_Guide/Command_Reference_Options/-\|/-]] <var>index</var> <var>string<sub>1</sub></var> <var>string<sub>2</sub></var>

	<code>~~var := TOKEN~~ [ /S ] ~~[ /D=delimiter~~ ] ~~/- <var>index</var> <var>string1 string2</var>~~</code>		This command, similar to the <code>[[Programmer Guide/Command Reference/WORD\|WORD]]</code> command, tokenises a string using blanks, or the specified delimiter.

	~~-> var = '~~token' or empty if <var>index</var> is not a number or outside the range 0 ~~.. nTokens-1~~		The command returns the respective token or an empty string if <var>index</var> is not a number or if it is outside the range 0…<var>nTokens</var>-1

	~~This command, similar to the~~ <~~code~~>~~[[Programmer Guide/Command Reference/WORD\|WORD]]~~</~~code~~> ~~command, tokenises a string using blanks, or the specified delimiter.~~

	When using <code>TOKEN</code>, do not forget to use the "/-" option before the first argument (and after any other options). Without the "/-" option, any argument starting with a slash will be mistaken for an option.		When using <code>TOKEN</code>, do not forget to use the [[Programmer_Guide/Command_Reference_Options/-\|<code>/-</code>]] option before the first argument (and after any other options). Without the [[Programmer_Guide/Command_Reference_Options/-\|<code>/-</code>]] option, any argument starting with a slash will be mistaken for an option.

	;<var>index</var>		;<var>index</var>
			:The zero-based index of the word to return (0 ≤ <var>index</var> ≤ <var>nWords</var>-1).

	~~:The zero-based index of the word to return (0~~ <= <var>~~index~~</var> <~~= nWords-1).~~		;<var>string<sub>1</sub></var> <var>string<var>2</var></var>

	;<var>~~string1, string2~~</var>

	:A string to tokenise.		:A string to tokenise.

	;<~~var~~>/S</~~var~~>		;<code>[[Command_Reference_Options/Silent\|/Silent]]</code>

	:If set, the function sets the return code on failure. Otherwise, it sets the return code to 0, even if the parameters are invalid.		:If set, the function sets the return code on failure. Otherwise, it sets the return code to 0, even if the parameters are invalid.

	;<~~var~~>/D</~~var~~>		;<code>/Delimiter</code>

	:Set the delimiter using the following format:		:Set the delimiter using the following format:
			:<code>/Delimiter=</code><var>delimiter</var>, e.g. <code>#var := token /D=, /- $#index $#wordlist</code>
	:/D=delimiter

	:E.g.:

	:#var := token /D=, /- $#index $#wordlist

	:The default delimiter is a blank.		:The default delimiter is a blank.

	Example:		== Example ==

	~~<pre>~~		#str := set 'to be, or not to be, that is the question'
	#str := set 'to be, or not to be, that is the question'		#var := token /D=, /- 1 $#str
	#var := token /D=, /- 1 $#str		um The second comma separated value in the string "$#str" is "$#var"
	um The second comma separated value in the string "$#str" is "$#var"		// will return ' or not to be'
	// will return ' or not to be'
	~~</pre>~~

Admin: 1 revision: Initial import

2010-11-18T16:31:35Z

1 revision: Initial import

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