PeekChar (StringTokenizer function): Difference between revisions
m (1 revision) |
m (→Examples) |
||
| (3 intermediate revisions by one other user not shown) | |||
| 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 | ||
| 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, < | 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' | ||
[[Targeted Text statements#AuditText, PrintText, and TraceText|PrintText]] {%tok:peekChar} | |||
printText {%tok:peekChar} | printText {%tok:peekChar} | ||
printText {%tok:nextChar} | printText {%tok:nextChar} | ||
Latest revision as of 20:33, 15 November 2012
Value of character at current tokenizing position, do not advance (StringTokenizer class)
This method returns the value of
the character that is at the tokenizing position.
The tokenizing position is the value returned by NextPosition.
After returning the character value, PeekChar does not advance the tokenizing position, which remains what it was when PeekChar was called.
Syntax
%string = stringTokenizer:PeekChar
Syntax terms
| %string | A string variable to receive the value of the character at the tokenizing position. |
|---|---|
| stringTokenizer | A StringTokenizer object expression. |
Usage notes
- If the value of AtEnd is
True, issuing PeekChar is invalid and cancels the request. - The NextChar function also returns the value of the next character, but it advances the tokenizing position past the next character.
Examples
The following sequence of printText statements display,
respectively, A, A, A, and n,
showing that the tokenizing position does not move after PeekChar completes,
PeekChar and NextChar return the same value, and NextChar does
advance the tokenizing position:
%tok:string = 'An example of peekChar' PrintText {%tok:peekChar} printText {%tok:peekChar} printText {%tok:nextChar} printText {%tok:nextChar}