StartOfString (StringTokenizer function): Difference between revisions

Revision as of 20:04, 31 December 2010

Substring that precedes first character of current toke

StartOfString is a member of the StringTokenizer class.

This method returns the substring of the tokenizer string that precedes the first character of the current token.

  %string = %tok:StartOfString

%string: A string variable to receive the characters that precede the current position.
%tok: A StringTokenizer object variable.

StartOfString does not advance the position.
The substring returned by StartOfString ends at (but does not include) the first character of the current token, the position of which is the value of CurrentTokenPosition. The value of the current token is returned by CurrentToken.
StartOfString returns a null string if it is issued before a token is found or if the value of NextPosition is 1.
The RestOfString function returns the substring of the tokenizer string that follows the present tokenizing position.

The following request fragment shows that consecutive StartOfString statements do not advance the position:

    %tok:string = 'A StartOfString example'
    %tok:findToken:('example')
    printText {%tok:startOfString}
    printText {%tok:startOfString}\\

The result is:

    A StartOfString
    A StartOfString \\

@@ Line 1: / Line 1: @@
 <span style="font-size:120%; color:black"><b>Substring that precedes first character of current toke</b></span>
 [[Category:StringTokenizer methods|StartOfString function]]
-[[Category:System methods]]
 <!--DPL?? Category:StringTokenizer methods|StartOfString function: Substring that precedes first character of current toke-->
 <!--DPL?? Category:System methods|StartOfString (StringTokenizer function): Substring that precedes first character of current toke-->