$Lstr_SubWord

Substring of a longstring using word counts

Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for $Lstr_SubWord is Words. Or, you may find the features of the StringTokenizer to be more helpful.

This function takes a string or longstring input and produces a substring of the input using word counts.

The $Lstr_SubWord function accepts four arguments and returns a long string result.

The first argument is an arbitrary string or longstring. This is a required argument.

The second argument is a number between 1 and 2**31-1 that indicates the starting word number in the input string. This is a required argument.

The third argument is a number between 1 and 2**31-1 that indicates the length in words of the result string. This is an optional argument and defaults to the number of words left in the string.

The fourth argument is a string containing from 1 to 255 characters which are the delimiters for the longstring. This is an optional argument and defaults to a blank.

Leading and trailing delimiters are removed from the resulting string, but all delimiters within the boundaries of the result are preserved.

Syntax

<section begin="syntax" />%result = $Lstr_SubWord(longstring, start, words, delim) <section end="syntax" />

$Lstr_SubWord function

%result is a substring of the input longstring.

For example

%RES = $Lstr_SubWord('Once upon a time you dressed so fine', 3, 2)

sets %RES to "a time." and

%RES = $Lstr_SubWord('Once upon a time you dressed so fine', 3, 2, ' n')

sets %RES to "upon a"

$Lstr_SubWord is only available in Sirius Mods Version 6.5 and later.

Products authorizing $Lstr_SubWord

$Lstr_SubWord

Syntax

See also

Products authorizing $Lstr_SubWord

Navigation menu