$Lstr Windex: Difference between revisions
(Created page with "{{DISPLAYTITLE:$Lstr_Windex}} <span class="pageSubtitle"><section begin="desc" />Return the position of a word within a long string<section end="desc" /></span> <p class="warnin...") |
m (1 revision) |
(No difference)
|
Revision as of 22:28, 8 February 2011
<section begin="desc" />Return the position of a word within a long string<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Lstr_Windex function is to be entered.
This function takes a string or longstring input and returns a number indicating the word position of the second argument within the long string. If the word is not present, zero is returned.
The $Lstr_Windex function accepts three arguments and returns a string result.
The first argument is an arbitrary string or longstring. This is a required argument.
The second argument is an arbitrary string containing a single word. The word must have no occurrences of any of the delimiters in argument three, and may not be null. This is a required argument.
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_Windex(longstring, word, delims) <section end="syntax" />
For example
%RES = $Lstr_Windex('She sells sea-shells by the sea shore', 'sea')
sets %RES to "6.&CQ. and
%RES = $Lstr_Windex('She sells sea-shells by the sea shore', 'sea', '- ')
sets %RES to "3&CQ.
For more information see :hdref refid=lstr..
$Lstr_Windex is only available in Sirius Mods Version 6.5 and later.