$Lstr Word: Difference between revisions
mNo edit summary |
m (→Syntax) |
||
Line 19: | Line 19: | ||
<p class="caption">$Lstr_Word function | <p class="caption">$Lstr_Word function | ||
</p> | </p> | ||
<p class="caption">%RESULT is the | <p class="caption">%RESULT is the ''n''th word in the longstring.</p> | ||
For example | For example |
Revision as of 14:42, 27 April 2011
<section begin="desc" />Return a word from a long string<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is no direct OO equivalent for the $Lstr_Word function, but the functionality is available in the StringTokenizer class.
This function takes a longstring input and a word number and returns a longstring containing a single word. A null string is returned if the word count in the input longstring is less than the word number.
The $Lstr_Word function accepts three arguments and returns a longstring result.
The first argument is an arbitrary longstring. This is a required argument.
The second argument is the number of the desired word. The first word in the input longstring is word 1.
The third 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.
Syntax
<section begin="syntax" /> %RESULT = $Lstr_Word(longstring, n, delims) <section end="syntax" />
For example
%RES = $Lstr_Word('She sells sea-shells by the sea shore', 7)
sets %RES to "shore" and
%RES = $Lstr_Word('She sells sea-shells by the sea shore', 7, '- ')
sets %RES to "sea".
$Lstr_Word is only available in Sirius Mods Version 6.5 and later. Prior to Version 7.3 (or Version 7.1 or 7.2, with maintenance applied), if the result of $Lstr_Word was longer than 255 bytes, either the request was cancelled or the result was truncated at 255 bytes.