$Lstr Windex: Difference between revisions
m (1 revision) |
m (1 revision) |
||
Line 19: | Line 19: | ||
<p class="caption">$Lstr_Windex function | <p class="caption">$Lstr_Windex function | ||
</p> | </p> | ||
<p class="caption">% | <p class="caption">%result is the position of '''word''' within '''longstring'''.</p> | ||
For example | For example |
Revision as of 20:44, 24 October 2012
Return the position of a word within a long string
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for $Lstr_Windex is WordNumberIn. Or, you may find the features of the StringTokenizer to be more helpful.
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" and
%RES = $Lstr_Windex('She sells sea-shells by the sea shore', 'sea', '- ')
sets %RES to "3".
$Lstr_Windex is only available in Sirius Mods Version 6.5 and later.
See also
- Word - Select word from list of words
- Words - Sublist of list of words
- WordCount - Count words in list
- WordNumberIn and WordNumberOf - Word number of "needle" word within "haystack" list of words