Substring (StringTokenizer function)

Specified substring within tokenizing string

Substring is a member of the StringTokenizer class.

This function returns a substring that is a specified length and starts at a specific position in the tokenizing string. The substring may be padded on the right.

Syntax

  %string = %tok:Substring(start, length, [Pad=char])

Syntax terms

%string

A string variable to contain the returned substring.

%tok

A StringTokenizer object variable.

start

The starting byte number in the tokenizing string to return.

length

The number of bytes to return. If the tokenizing string has fewer characters than the requested bytes (starting at the start position), it is either padded to the requested length, or the entire tokenizing string starting at the start position is returned with no padding, depending on the value of the Pad parameter.

Pad=char

The character used to pad the result substring on the right if the result is shorter than the requested length. char defaults to a null, which means no padding is done. Pad is a name-required parameter.

Usage Notes

• The length must be a non-negative number. A negative number results in request cancellation.
• The pad parameter must be either null or a single character. A longer value results in request cancellation in Sirius Mods version 7.2 and in a compilation error in Sirius Mods 7.3 and higher.

Examples

The following request prints “nizer Substring example!!!!!”:

    begin
    %tok is object stringtokenizer
    %tok = new
    %tok:string = 'a tokenizer Substring example'
    %sub = %tok:substring(7, 28, pad='!')
    printText {~} is {%tok:substring(7, 28, pad='!')}
    end