FindToken (StringTokenizer function) - Revision history

JAL: /* Examples */

2014-10-10T23:19:17Z

Examples

← Older revision		Revision as of 23:19, 10 October 2014
Line 53:		Line 53:
	%tok:currentToken is 7bit		%tok:currentToken is 7bit
	</p>		</p>
	'''Note:'''		<p class="note">'''Note:'''
	Printing an enumeration value is described in the <var>ToString</var> property discussion in [[Enumerations#printenum\|"Usage notes"]].		Printing an enumeration value is described in the <var>ToString</var> property discussion in [[Enumerations#printenum\|Usage notes on the "Enumerations" page]]. </p>

	==See also==		==See also==
	{{Template:StringTokenizer:FindToken footer}}		{{Template:StringTokenizer:FindToken footer}}

JAL at 17:32, 15 November 2012

2012-11-15T17:32:11Z

← Older revision		Revision as of 17:32, 15 November 2012
Line 1:		Line 1:
	{{Template:StringTokenizer:FindToken subtitle}}		{{Template:StringTokenizer:FindToken subtitle}}

	This [[Notation conventions for methods#Callable functions\|callable]] method returns a <var>Boolean ~~value~~</var> that indicates whether		This [[Notation conventions for methods#Callable functions\|callable]] method returns a <var>[[Boolean enumeration]]</var> value that indicates whether
	it finds a specified token.		it finds a specified token. The value is <code>True</code> if the token is found; otherwise it is <code>False</code>.
	The value is <code>True</code> if the token is found;		The search starts from the tokenizing position, the value of which is returned by <var>[[NextPosition (StringTokenizer property)\|NextPosition]]</var>.
	otherwise it is <code>False</code>.
	The search starts from the tokenizing position,
	the value of which is returned by <var>[[NextPosition (StringTokenizer property)\|NextPosition]]</var>.

	If the token is found, the position in		If the token is found, the position in the string is advanced past the found token, and <var>[[CurrentToken (StringTokenizer function)\|CurrentToken]]</var>
	the string is advanced past the found token, and <var>[[CurrentToken (StringTokenizer function)\|CurrentToken]]</var>
	will return the found token.		will return the found token.
	Otherwise, <var>[[AtEnd (StringTokenizer function)\|AtEnd]]</var> is set to <code>True</code>, and <var>CurrentToken</var>		Otherwise, <var>[[AtEnd (StringTokenizer function)\|AtEnd]]</var> is set to <code>True</code>, and <var>CurrentToken</var>
	is set to the last token at the end of the string.		is set to the last token at the end of the string.

	~~Not up to date - do other pages have similar error[??]:~~
	~~The delimiters that are involved in determining the tokens~~
	~~are set initially by the <var>[[New (StringTokenizer constructor)\|New]]</var> constructor~~
	~~that instantiates the <var>StringTokenizer</var> object.~~
	~~The delimiters can be modified by the <var>[[Spaces (StringTokenizer property)\|Spaces]]</var>,~~
	~~<var>[[Quotes (StringTokenizer property)\|Quotes]]</var>, and <var>[[TokenChars (StringTokenizer property)\|TokenChars]]</var> properties.~~

	==Syntax==		==Syntax==
Line 27:		Line 16:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%boolean</th>		<tr><th>%boolean</th>
	<td>An enumeration object of type <var>Boolean</var> to contain the returned value of <var>FindToken</var>.		<td>An enumeration object of type <var>Boolean</var> to contain the returned value of <var>FindToken</var>.</td></tr>

	~~For more information about <var>Boolean</var> enumerations, see [[Enumerations#Using_Boolean_enumerations\|"Using Boolean Enumerations"]]~~.</td></tr>

	<tr><th>stringTokenizer</th>		<tr><th>stringTokenizer</th>
Line 44:		Line 31:

	<li>The <var>NextToken</var> and <var>[[PeekToken (StringTokenizer function)\|PeekToken]]</var>		<li>The <var>NextToken</var> and <var>[[PeekToken (StringTokenizer function)\|PeekToken]]</var>
	functions also return the next token.		functions also return the next token. Like <var>FindToken</var>, <var>NextToken</var>
	Like <var>FindToken</var>, <var>NextToken</var>
	advances the tokenizing position to the character or position following that token.		advances the tokenizing position to the character or position following that token.
	<var>PeekToken</var>, however, does not advance the tokenizing position.		<var>PeekToken</var>, however, does not advance the tokenizing position.
Line 55:		Line 41:
	<p class="code">%tok = new(tokenchars='-')		<p class="code">%tok = new(tokenchars='-')
	%tok:string = 'Content-Transfer-Encoding: 7bit'		%tok:string = 'Content-Transfer-Encoding: 7bit'
	PrintText {~} is {%tok:findToken('Transfer')}		[[Targeted Text statements#AuditText, PrintText, and TraceText\|PrintText]] {~} is {%tok:findToken('Transfer')}
	PrintText {~} is {%tok:findToken('8bit')}		[[Targeted Text statements#AuditText, PrintText, and TraceText\|PrintText]] {~} is {%tok:findToken('8bit')}
	PrintText {~} is {%tok:AtEnd}		PrintText {~} is {%tok:AtEnd}
	PrintText {~} is {%tok:currentToken}		PrintText {~} is {%tok:currentToken}
Line 68:		Line 54:
	</p>		</p>
	'''Note:'''		'''Note:'''
	~~Using the PrintText statement is described in [[Targeted Text statements\|"Targeted Text statements"]].~~		Printing an enumeration value is described in the <var>ToString</var> property discussion in [[Enumerations#printenum\|"Usage notes"]].
	Printing an enumeration value is described in [[Enumerations#printenum\|~~ToString property~~ "Usage notes"]].

	==See also==		==See also==
	{{Template:StringTokenizer:FindToken footer}}		{{Template:StringTokenizer:FindToken footer}}

JAL at 00:25, 1 November 2012

2012-11-01T00:25:22Z

← Older revision		Revision as of 00:25, 1 November 2012
Line 1:		Line 1:
	{{Template:StringTokenizer:FindToken subtitle}}		{{Template:StringTokenizer:FindToken subtitle}}

	This callable method returns a <var>Boolean value</var> that indicates whether		This [[Notation conventions for methods#Callable functions\|callable]] method returns a <var>Boolean value</var> that indicates whether
	it finds a specified token.		it finds a specified token.
	The value is <code>True</code> if the token is found;		The value is <code>True</code> if the token is found;

Dme at 01:15, 10 October 2012

2012-10-10T01:15:50Z

← Older revision		Revision as of 01:15, 10 October 2012
Line 14:		Line 14:
	is set to the last token at the end of the string.		is set to the last token at the end of the string.

			Not up to date - do other pages have similar error[??]:
	The delimiters that are involved in determining the tokens		The delimiters that are involved in determining the tokens
	are set initially by the <var>[[New (StringTokenizer constructor)\|New]]</var> constructor		are set initially by the <var>[[New (StringTokenizer constructor)\|New]]</var> constructor

JAL2 at 22:07, 5 July 2012

2012-07-05T22:07:15Z

← Older revision		Revision as of 22:07, 5 July 2012
Line 1:		Line 1:
	{{Template:StringTokenizer:FindToken subtitle}}		{{Template:StringTokenizer:FindToken subtitle}}

	This callable method returns a Boolean value that indicates whether		This callable method returns a <var>Boolean value</var> that indicates whether
	it finds a specified token.		it finds a specified token.
	The value is <code>True</code> if the token is found;		The value is <code>True</code> if the token is found;
	otherwise it is <code>False</code>.		otherwise it is <code>False</code>.
	The search starts from the tokenizing position,		The search starts from the tokenizing position,
	the value of which is returned by [[NextPosition (StringTokenizer property)\|NextPosition]].		the value of which is returned by <var>[[NextPosition (StringTokenizer property)\|NextPosition]]</var>.

	If the token is found, the position in		If the token is found, the position in
	the string is advanced past the found token, and [[CurrentToken (StringTokenizer function)\|CurrentToken]]		the string is advanced past the found token, and <var>[[CurrentToken (StringTokenizer function)\|CurrentToken]]</var>
	will return the found token.		will return the found token.
	Otherwise, [[AtEnd (StringTokenizer function)\|AtEnd]] is set to <code>True</code>, and <var>CurrentToken</var>		Otherwise, <var>[[AtEnd (StringTokenizer function)\|AtEnd]]</var> is set to <code>True</code>, and <var>CurrentToken</var>
	is set to the last token at the end of the string.		is set to the last token at the end of the string.

	The delimiters that are involved in determining the tokens		The delimiters that are involved in determining the tokens
	are set initially by the [[New (StringTokenizer constructor)\|New]] constructor		are set initially by the <var>[[New (StringTokenizer constructor)\|New]]</var> constructor
	that instantiates the <var>StringTokenizer</var> object.		that instantiates the <var>StringTokenizer</var> object.
	The delimiters can be modified by the [[Spaces (StringTokenizer property)\|Spaces]],		The delimiters can be modified by the <var>[[Spaces (StringTokenizer property)\|Spaces]]</var>,
	[[Quotes (StringTokenizer property)\|Quotes]], and [[TokenChars (StringTokenizer property)\|TokenChars]] properties.		<var>[[Quotes (StringTokenizer property)\|Quotes]]</var>, and <var>[[TokenChars (StringTokenizer property)\|TokenChars]]</var> properties.

	==Syntax==		==Syntax==
	{{Template:StringTokenizer:FindToken syntax}}		{{Template:StringTokenizer:FindToken syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 27:		Line 29:

	For more information about <var>Boolean</var> enumerations, see [[Enumerations#Using_Boolean_enumerations\|"Using Boolean Enumerations"]].</td></tr>		For more information about <var>Boolean</var> enumerations, see [[Enumerations#Using_Boolean_enumerations\|"Using Boolean Enumerations"]].</td></tr>

	<tr><th>stringTokenizer</th>		<tr><th>stringTokenizer</th>
	<td>A <var>StringTokenizer</var> object expression. </td></tr>		<td>A <var>StringTokenizer</var> object expression. </td></tr>

	<tr><th>string</th>		<tr><th>string</th>
	<td>A string that is the token to be located.</td></tr>		<td>A string that is the token to be located.</td></tr>
Line 36:		Line 40:
	<ul>		<ul>
	<li>For a new <var>StringTokenizer</var> instance, issuing <var>FindToken</var>,		<li>For a new <var>StringTokenizer</var> instance, issuing <var>FindToken</var>,
	[[NextToken (StringTokenizer function)\|NextToken]], or [[SkipTokens (StringTokenizer subroutine)\|SkipTokens]] is		<var>[[NextToken (StringTokenizer function)\|NextToken]]</var>, or <var>[[SkipTokens (StringTokenizer subroutine)\|SkipTokens]]</var> is required before <var>[[CurrentToken (StringTokenizer function)\|CurrentToken]]</var> may be issued without error.
	required before [[CurrentToken (StringTokenizer function)\|CurrentToken]] may be issued without error.
	<li>The <var>NextToken</var> and [[PeekToken (StringTokenizer function)\|PeekToken]]		<li>The <var>NextToken</var> and <var>[[PeekToken (StringTokenizer function)\|PeekToken]]</var>
	functions also return the next token.		functions also return the next token.
	Like <var>FindToken</var>, <var>NextToken</var>		Like <var>FindToken</var>, <var>NextToken</var>
	advances the tokenizing position to the character or position following that token.		advances the tokenizing position to the character or position following that token.
	PeekToken, however, does not advance the tokenizing position.		<var>PeekToken</var>, however, does not advance the tokenizing position.
	</ul>		</ul>

	==Examples==		==Examples==

	The following code fragment shows a <var>FindToken</var> call that locates its target,		The following code fragment shows a <var>FindToken</var> call that locates its target,
	then a <var>FindToken</var> call that does not locate its target:		then a <var>FindToken</var> call that does not locate its target:
Line 63:		Line 67:
	</p>		</p>
	'''Note:'''		'''Note:'''
	Using the PrintText statement is described in [[Targeted Text statements\|~~PrintText~~]].		Using the PrintText statement is described in [[Targeted Text statements\|"Targeted Text statements"]].
	~~Using PrintText to print~~ an enumeration value is described ~~in the first "Note" ??~~		Printing an enumeration value is described in [[Enumerations#printenum\|ToString property "Usage notes"]].
	in [[Enumerations#~~Using enumerations~~\|~~Using enumerations~~]].
	==See also==		==See also==
	{{Template:StringTokenizer:FindToken footer}}		{{Template:StringTokenizer:FindToken footer}}

JALWiccan: 1 revision

2012-07-05T21:25:47Z

1 revision

← Older revision	Revision as of 21:25, 5 July 2012
(No difference)

JALWiccan: 1 revision

2012-07-05T21:25:46Z

1 revision

← Older revision		Revision as of 21:25, 5 July 2012
Line 11:		Line 11:
	the string is advanced past the found token, and [[CurrentToken (StringTokenizer function)\|CurrentToken]]		the string is advanced past the found token, and [[CurrentToken (StringTokenizer function)\|CurrentToken]]
	will return the found token.		will return the found token.
	Otherwise, [[AtEnd (StringTokenizer function)\|AtEnd]] is set to <code>True</code>, and CurrentToken		Otherwise, [[AtEnd (StringTokenizer function)\|AtEnd]] is set to <code>True</code>, and <var>CurrentToken</var>
	is set to the last token at the end of the string.		is set to the last token at the end of the string.

JALWiccan: 1 revision

2012-07-05T21:20:39Z

1 revision

← Older revision	Revision as of 21:20, 5 July 2012
(No difference)

JALWiccan: 1 revision

2012-07-05T21:20:38Z

1 revision

← Older revision		Revision as of 21:20, 5 July 2012
Line 38:		Line 38:
	[[NextToken (StringTokenizer function)\|NextToken]], or [[SkipTokens (StringTokenizer subroutine)\|SkipTokens]] is		[[NextToken (StringTokenizer function)\|NextToken]], or [[SkipTokens (StringTokenizer subroutine)\|SkipTokens]] is
	required before [[CurrentToken (StringTokenizer function)\|CurrentToken]] may be issued without error.		required before [[CurrentToken (StringTokenizer function)\|CurrentToken]] may be issued without error.
	<li>The NextToken and [[PeekToken (StringTokenizer function)\|PeekToken]]		<li>The <var>NextToken</var> and [[PeekToken (StringTokenizer function)\|PeekToken]]
	functions also return the next token.		functions also return the next token.
	Like <var>FindToken</var>, NextToken		Like <var>FindToken</var>, <var>NextToken</var>
	advances the tokenizing position to the character or position following that token.		advances the tokenizing position to the character or position following that token.
	PeekToken, however, does not advance the tokenizing position.		PeekToken, however, does not advance the tokenizing position.

JALWiccan: 1 revision

2012-07-05T21:02:57Z

1 revision

← Older revision	Revision as of 21:02, 5 July 2012
(No difference)