PeekChar (StringTokenizer function) - Revision history

JAL: /* Examples */

2012-11-15T20:33:15Z

Examples

← Older revision		Revision as of 20:33, 15 November 2012
Line 35:		Line 35:
	advance the tokenizing position:		advance the tokenizing position:
	<p class="code">%tok:string = 'An example of peekChar'		<p class="code">%tok:string = 'An example of peekChar'
	~~printText~~ {%tok:peekChar}		[[Targeted Text statements#AuditText, PrintText, and TraceText\|PrintText]] {%tok:peekChar}
	printText {%tok:peekChar}		printText {%tok:peekChar}
	printText {%tok:nextChar}		printText {%tok:nextChar}

JAL2 at 21:14, 5 July 2012

2012-07-05T21:14:45Z

← Older revision		Revision as of 21:14, 5 July 2012
Line 3:		Line 3:
	This method returns the value of		This method returns the value of
	the character that is at the tokenizing position.		the character that is at the tokenizing position.
	The tokenizing position is the value returned by [[NextPosition (StringTokenizer property)\|NextPosition]].		The tokenizing position is the value returned by <var>[[NextPosition (StringTokenizer property)\|NextPosition]]</var>.

	After returning the character value, <var>PeekChar</var> does not advance the		After returning the character value, <var>PeekChar</var> does not advance the

JAL2: /* Examples */

2012-07-05T21:14:20Z

Examples

← Older revision		Revision as of 21:14, 5 July 2012
Line 32:		Line 32:
	respectively, <code>A</code>, <code>A</code>, <code>A</code>, and <code>n</code>,		respectively, <code>A</code>, <code>A</code>, <code>A</code>, and <code>n</code>,
	showing that the tokenizing position does not move after <var>PeekChar</var> completes,		showing that the tokenizing position does not move after <var>PeekChar</var> completes,
	<var>PeekChar</var> and NextChar return the same value, and NextChar does		<var>PeekChar</var> and <var>NextChar</var> return the same value, and <var>NextChar</var> does
	advance the tokenizing position:		advance the tokenizing position:
	<p class="code">%tok:string = 'An example of peekChar'		<p class="code">%tok:string = 'An example of peekChar'

JAL2 at 21:13, 5 July 2012

2012-07-05T21:13:32Z

← Older revision		Revision as of 21:13, 5 July 2012
Line 22:		Line 22:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the value of [[AtEnd (StringTokenizer function)\|AtEnd]] is <code>True</code>,		<li>If the value of <var>[[AtEnd (StringTokenizer function)\|AtEnd]]</var> is <code>True</code>,
	issuing <var>PeekChar</var> is invalid and cancels the request.		issuing <var>PeekChar</var> is invalid and cancels the request.
	<li>The [[NextChar (StringTokenizer function)\|NextChar]] function also returns the value of the		<li>The <var>[[NextChar (StringTokenizer function)\|NextChar]]</var> function also returns the value of the
	next character, but it advances the tokenizing position past the next character.		next character, but it advances the tokenizing position past the next character.
	</ul>		</ul>
Line 30:		Line 30:
	==Examples==		==Examples==
	The following sequence of printText statements display,		The following sequence of printText statements display,
	respectively, <tt>A</tt>, <tt>A</tt>, <tt>A</tt>, and <tt>n</tt>,		respectively, <code>A</code>, <code>A</code>, <code>A</code>, and <code>n</code>,
	showing that the tokenizing position does not move after <var>PeekChar</var> completes,		showing that the tokenizing position does not move after <var>PeekChar</var> completes,
	<var>PeekChar</var> and NextChar return the same value, and NextChar does		<var>PeekChar</var> and NextChar return the same value, and NextChar does

JALWiccan: 1 revision

2012-07-05T20:59:39Z

1 revision

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

JAL2 at 20:59, 5 July 2012

2012-07-05T20:59:38Z

← Older revision		Revision as of 20:59, 5 July 2012
Line 22:		Line 22:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the value of [[AtEnd (StringTokenizer function)\|AtEnd]] is <tt>True</tt>,		<li>If the value of [[AtEnd (StringTokenizer function)\|AtEnd]] is <code>True</code>,
	issuing <var>PeekChar</var> is invalid and cancels the request.		issuing <var>PeekChar</var> is invalid and cancels the request.
	<li>The [[NextChar (StringTokenizer function)\|NextChar]] function also returns the value of the		<li>The [[NextChar (StringTokenizer function)\|NextChar]] function also returns the value of the

JAL2 at 20:56, 5 July 2012

2012-07-05T20:56:44Z

New page

{{Template:StringTokenizer:PeekChar subtitle}}

This method returns the value of
the character that is at the tokenizing position.
The tokenizing position is the value returned by [[NextPosition (StringTokenizer property)|NextPosition]].

After returning the character value, <var>PeekChar</var> does not advance the
tokenizing position,
which remains what it was when <var>PeekChar</var> was called.

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

===Syntax terms===
<table class="syntaxTable">
<tr><th>%string</th>
<td>A string variable to receive the value of the character at the tokenizing position. </td></tr>
<tr><th>stringTokenizer</th>
<td>A <var>StringTokenizer</var> object expression.</td></tr>
</table>

==Usage notes==
<ul>
<li>If the value of [[AtEnd (StringTokenizer function)|AtEnd]] is <tt>True</tt>,
issuing <var>PeekChar</var> is invalid and cancels the request.
<li>The [[NextChar (StringTokenizer function)|NextChar]] function also returns the value of the
next character, but it advances the tokenizing position past the next character.
</ul>

==Examples==
The following sequence of printText statements display,
respectively, <tt>A</tt>, <tt>A</tt>, <tt>A</tt>, and <tt>n</tt>,
showing that the tokenizing position does not move after <var>PeekChar</var> completes,
<var>PeekChar</var> and NextChar return the same value, and NextChar does
advance the tokenizing position:
<p class="code">%tok:string = 'An example of peekChar'
printText {%tok:peekChar}
printText {%tok:peekChar}
printText {%tok:nextChar}
printText {%tok:nextChar}
</p>

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

Wiccan: 1 revision

2011-02-06T21:48:05Z

1 revision

← Older revision	Revision as of 21:48, 6 February 2011
(No difference)

Wiccan: 1 revision

2011-02-06T21:48:03Z

1 revision

← Older revision		Revision as of 21:48, 6 February 2011
Line 31:		Line 31:
	<var>PeekChar</var> and NextChar return the same value, and NextChar does		<var>PeekChar</var> and NextChar return the same value, and NextChar does
	advance the tokenizing position:		advance the tokenizing position:
	<~~pre~~>		<p class="code">%tok:string = 'An example of peekChar'
	%tok:string = 'An example of peekChar'		printText {%tok:peekChar}
	printText {%tok:peekChar}		printText {%tok:peekChar}
	printText {%tok:peekChar}		printText {%tok:nextChar}
	printText {%tok:nextChar}		printText {%tok:nextChar}
	printText {%tok:nextChar}		</p>
	</~~pre~~>
	==See also==		==See also==
	{{Template:StringTokenizer:PeekChar footer}}		{{Template:StringTokenizer:PeekChar footer}}

Wiccan: 1 revision

2011-02-06T21:47:22Z

1 revision

← Older revision	Revision as of 21:47, 6 February 2011
(No difference)