CurrentQuoted (StringTokenizer function)

Is current token a quoted token?

CurrentQuoted is a member of the StringTokenizer class.

This method returns a Boolean value that indicates whether the current token is a quoted token. A quoted token contains all the characters between a pair of identical quotation characters.

The CurrentQuoted value is True if the current token is quoted; otherwise it is False.

Syntax

  %bool = %tok:CurrentQuoted

Syntax terms

%bool

An enumeration object of type Boolean to contain the returned value of CurrentQuoted. For more information about Boolean enumerations, see Using Boolean enumerations.

%tok

A StringTokenizer object variable.

Usage Notes

• The Quotes characters are initially settable in the New) call that creates the tokenizer instance.
• A quotation character may participate in only one quoted region. The first quotation character from the beginning of the tokenization string is paired with the following identical quotation character in the string. An unpaired quotation character causes a request cancellation.
• A quoted region is not affected by the TokensToLower and TokensToUpper properties.
• The RemoveQuotes property controls whether quotes are removed from the returned values of quoted tokens.

Examples

In the following request fragment, the selection of a quoted token is verified by a CurrentQuoted call:

    %tok = new(quotes='"')
    %tok:string = 'simple "quoted tokens" example'
    PrintText {~} is {%tok:nextToken}
    PrintText {~} is {%tok:nextToken}
    PrintText {~} is {%tok:currentToken}
    PrintText {~} is {%tok:currentQuoted}

The result is:

    %tok:nextToken is simple
    %tok:nextToken is quoted tokens
    %tok:currentToken is quoted tokens
    %tok:currentQuoted is True

Note: Using the PrintText statement is described in PrintText. Using PrintText to print an enumeration value is described in the first “Note” in ?? refid=crenums..