Programmer Guide/Command Reference/READ - Revision history

Jw at 12:20, 13 August 2018

2018-08-13T12:20:56Z

← Older revision		Revision as of 14:20, 13 August 2018
Line 76:		Line 76:

	For more <code>READ</code> examples, see the <code>read_example.sts</code> script.		For more <code>READ</code> examples, see the <code>read_example.sts</code> script.

			See also [[../WRITE\|WRITE]].

Christian at 14:22, 28 April 2014

2014-04-28T14:22:13Z

← Older revision		Revision as of 16:22, 28 April 2014
Line 51:		Line 51:

	;<code>/Escape=<var>escapechar</var></code>		;<code>/Escape=<var>escapechar</var></code>
	:You can define an escape character using the <code>/E</code> option. E.g. defining '<code>\</code>' as the escape character will change parsing as follows:		:You can define an escape character of your own using the <code>/Escape</code> option. E.g. defining "<code>\</code>" as the escape character by supplying <code>/Escape=\</code> will change parsing as follows:

	READSTR 'a b \, c' #a','#b /D		READSTR 'a b \, c' #a','#b /D

Christian at 14:20, 28 April 2014

2014-04-28T14:20:41Z

Christian at 14:19, 28 April 2014

2014-04-28T14:19:48Z

← Older revision		Revision as of 16:19, 28 April 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	READ <var>file</var> <var>varseplist</var> [/D] [ /N ] [ /E[=<var>~~escapeseq~~</var>] ] [ /S ] [ /R=<var>x</var> ]		READ <var>file</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /R=<var>x</var> ]

	READSTR <var>string</var> <var>varseplist</var> [/D] [ /N ] [ /E[=<var>~~escapeseq~~</var>] ] [ /S ][ /R=<var>x</var> ]		READSTR <var>string</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ][ /R=<var>x</var> ]

	READVAR <var>var</var> <var>varseplist</var> [/D] [ /N ] [ /E[=<var>~~escapeseq~~</var>] ] [ /S ] [ /R=<var>x</var> ]		READVAR <var>var</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /R=<var>x</var> ]

	READTAB <var>table</var> <var>iEntry</var> <var>varseplist</var> [/D] [ /N ] [ /E[=<var>~~escapeseq~~</var>] ] [ /S ]		READTAB <var>table</var> <var>iEntry</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ]

	READTAB <var>table</var> <var>iField</var> <var>varseplist</var> /C [/D] [ /N ] [ /E[=<var>~~escapeseq~~</var>] ] [ /S ]		READTAB <var>table</var> <var>iField</var> <var>varseplist</var> /Config [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ]

	READTAB <var>table</var> <var>iEntry</var> <var>iField</var> <var>varseplist</var> /F [/D] [ /N ] [ /E[=<var>~~escapeseq~~</var>] ] [ /S ]		READTAB <var>table</var> <var>iEntry</var> <var>iField</var> <var>varseplist</var> /Field [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ]

	The <code>READ</code> command and its variants <code>READSTR</code>, <code>READTAB</code> and <code>READVAR</code> parse data into variables:		The <code>READ</code> command and its variants <code>READSTR</code>, <code>READTAB</code> and <code>READVAR</code> parse data into variables:
Line 44:		Line 44:
	// #READ := 2		// #READ := 2

	;<code>/N</code>		;<code>/Noparsing</code>
	:If specified, no parsing, stripping or escape character handling takes place. The contents of the first argument are assigned to the second argument.		:If specified, no parsing, stripping or escape character handling takes place. The contents of the first argument are assigned to the second argument.

	;<code>/D</code>		;<code>/Delete</code>
	:If specified, the contents (if any) of the variables specified in <var>varseplist</var> are deleted before parsing.		:If specified, the contents (if any) of the variables specified in <var>varseplist</var> are deleted before parsing.

	;<code>/E</code>		;<code>/Escape=<var>escapechar</var></code>
	:You can define an escape character using the /E option. E.g. defining '<code>\</code>' as the escape character will change parsing as follows:		:You can define an escape character using the <code>/E</code> option. E.g. defining '<code>\</code>' as the escape character will change parsing as follows:

	READSTR 'a b \, c' #a','#b /D		READSTR 'a b \, c' #a','#b /D
Line 63:		Line 63:
	:The default escape character is the back-tick character, "<code>`</code>"		:The default escape character is the back-tick character, "<code>`</code>"

	;<code>/C</code>		;<code>/Config</code>
	:If specified, the contents of the table field's configuration is used as the input.		:If specified, the contents of the table field's configuration is used as the input.

	;<code>/F</code>		;<code>/Field</code>
	:If specified, the contents of the addressed entry field is used as the input.		:If specified, the contents of the addressed entry field is used as the input.

	;<code>/S</code>		;<code>[[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]]</code>
	:If specified, errors will generate warning messages rather than error messages. See The Silent Flag for details.		:If specified, errors will generate warning messages rather than error messages. See [[Programmer_Guide/Command_Reference_Options/Silent\|The Silent Flag]] for details.

	;<code>/T</code>		;<code>/T</code>

Christian at 14:15, 28 April 2014

2014-04-28T14:15:33Z

Show changes

193.171.195.53: /* READ */

2014-04-15T12:32:44Z

READ

← Older revision		Revision as of 14:32, 15 April 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	~~==READ==~~		READ <var>file varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ] [ /R=<var>x</var> ]

	~~<code>~~READ <var>file varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ] [ /R=<var>x</var> ]~~</code>~~		READSTR <var>string varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ][ /R=<var>x</var> ]

	~~<code>~~READSTR <var>string varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ][ /R=<var>x</var> ]~~</code>~~		READVAR <var>var varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ] [ /R=<var>x</var> ]

	~~<code>~~READVAR <var>var varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ] [ /R=<var>x</var> ]~~</code>~~		READTAB <var>table iEntry varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]

	~~<code>~~READTAB <var>table iEntry varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]~~</code>~~		READTAB <var>table iField varseplist</var> /C [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]

	~~<code>~~READTAB <var>table iField varseplist</var> /C [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]~~</code>~~		READTAB <var>table iEntry iField varseplist</var> /F [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]

	~~<code>~~READTAB <var>table iEntry iField varseplist</var> /F [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]~~</code>~~

	The <code>READ</code> command and its variants (<code>READSTR</code>, <code>READTAB</code> and <code>READVAR</code>) can be used to parse input into variables.		The <code>READ</code> command and its variants (<code>READSTR</code>, <code>READTAB</code> and <code>READVAR</code>) can be used to parse input into variables.

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}}}}
==READ==

<code>READ <var>file varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ] [ /R=<var>x</var> ]</code>

<code>READSTR <var>string varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ][ /R=<var>x</var> ]</code>

<code>READVAR <var>var varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ] [ /R=<var>x</var> ]</code>

<code>READTAB <var>table iEntry varseplist</var> [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]</code>

<code>READTAB <var>table iField varseplist</var> /C [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]</code>

<code>READTAB <var>table iEntry iField varseplist</var> /F [/D] [ /N ] [ /E[=<var>escapeseq</var>] ] [ /S ]</code>

The <code>READ</code> command and its variants (<code>READSTR</code>, <code>READTAB</code> and <code>READVAR</code>) can be used to parse input into variables.

The <code>READ</code> command parses the next line of the input file <var>file</var>, replacing the linefeed character (<code>\n</code>) with a string terminator (<code>\0</code>).

The <code>READSTR</code> command interprets the first parameter as a string, parsing it into the other parameters.

The <code>READVAR</code> command interprets the first parameter as a variable name, parsing it into the other parameters.

The <code>READTAB</code> command takes a table name and entry index as the first two parameters, and parses the contents of table entry specified by the index into the remaining parameters.

The parameter <var>varsepplist</var> is a list of variables to assign values to and separators to parse the input with. For example, this command reads an input string into three variables, using the default separator (the blank).

<pre>
READSTR 'a b c' #1 #2 #3
// #1 := a, #2 := b, #3 := c, #READ := 3
</pre>
If separators are specified, the string is tokenised accordingly.

<pre>
#var := set '10/8/2008 19:14'
READVAR #var #day'/'#month'/'#year' '#hour':'#minute
</pre>
If there are more tokens than variables, all remaining tokens are stored in the last variable.

<pre>
#var := set 'the big brown fox'
READVAR #var #1 #2 #3
// #1 := the, #2 := big, #3 := brown fox, #READ := 3
</pre>
The number of variables to which tokens were assigned is stored in the local variable <code>#READ</code>.

<pre>
READSTR '' #1 #2
// #READ := 0
READSTR 'a' #1 #2
// #READ := 1
READSTR 'a b c' #1 #2
// #READ := 2
</pre>
;<var>/N</var>

:If specified, no parsing, stripping or escape character handling takes place. The contents of the first argument are assigned to the second argument.

;<var>/D</var>

:If specified, the contents (if any) of the variables specified in <var>varseplist</var> are deleted before parsing.

;<var>/E</var>

:You can define an escape character using the /E option. E.g. defining '<code>\</code>' as the escape character will change parsing as follows:

<pre>
READSTR 'a b \, c' #a','#b /D
// #a := a b \
// #b := c
// #READ := 2
READSTR 'a b \, c' #a','#b /D /E=\
// #a := a b \, c
// #b :=
// #READ := 1
</pre>
:The default escape character is '<code>`</code>'

;<var>/C</var>

:If specified, the contents of the table field's configuration is used as the input.

;<var>/F</var>

:If specified, the contents of the addressed entry field is used as the input.

;<var>/S</var>

:If specified, errors will generate warning messages rather than error messages. See The Silent Flag for details.

;<var>/T</var>

:If specified, arguments will *not* have their left and right white space trimmed. The default is that they are trimmed.

For more <code>READ</code> examples, see the <code>read_example.sts</code> script.

← Older revision		Revision as of 16:20, 28 April 2014
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	READ <var>file</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /R=<var>x</var> ]		READ <var>file</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /R=<var>x</var> ] [ /Trimmenot ]

	READSTR <var>string</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ][ /R=<var>x</var> ]		READSTR <var>string</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ][ /R=<var>x</var> ] [ /Trimmenot ]

	READVAR <var>var</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /R=<var>x</var> ]		READVAR <var>var</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /R=<var>x</var> ] [ /Trimmenot ]

	READTAB <var>table</var> <var>iEntry</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ]		READTAB <var>table</var> <var>iEntry</var> <var>varseplist</var> [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /Trimmenot ]

	READTAB <var>table</var> <var>iField</var> <var>varseplist</var> /Config [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ]		READTAB <var>table</var> <var>iField</var> <var>varseplist</var> /Config [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /Trimmenot ]

	READTAB <var>table</var> <var>iEntry</var> <var>iField</var> <var>varseplist</var> /Field [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ]		READTAB <var>table</var> <var>iEntry</var> <var>iField</var> <var>varseplist</var> /Field [ /Delete ] [ /Noparsing ] [ /Escape[=<var>escapechar</var>] ] [ [[Programmer_Guide/Command_Reference_Options/Silent\|/Silent]] ] [ /Trimmenot ]

	The <code>READ</code> command and its variants <code>READSTR</code>, <code>READTAB</code> and <code>READVAR</code> parse data into variables:		The <code>READ</code> command and its variants <code>READSTR</code>, <code>READTAB</code> and <code>READVAR</code> parse data into variables:
Line 72:		Line 72:
	:If specified, errors will generate warning messages rather than error messages. See [[Programmer_Guide/Command_Reference_Options/Silent\|The Silent Flag]] for details.		:If specified, errors will generate warning messages rather than error messages. See [[Programmer_Guide/Command_Reference_Options/Silent\|The Silent Flag]] for details.

	;<code>/T</code>		;<code>/Trimmenot</code>
	:If specified, arguments will not have their left and right white space trimmed. The default is that they are trimmed.		:If specified, arguments will not have their left and right white space trimmed. The default is that they are trimmed.

	For more <code>READ</code> examples, see the <code>read_example.sts</code> script.		For more <code>READ</code> examples, see the <code>read_example.sts</code> script.