PeekChar (StringTokenizer function)

Value of character at current tokenizing position, don't adv

PeekChar is a member of the 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 = %tok:PeekChar

Syntax terms

%string

A string variable to receive the value of the character at the tokenizing position.

%tok

A StringTokenizer object variable.

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}