$Lstr Windex: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Return the position of a word within a long string<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Return the position of a word within a long string<section end="desc" /></span> | ||
<p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. | <p class="warning">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for <var>$Lstr_Windex</var> is <var>[[WordNumberIn (String function)|WordNumberIn]]</var>. Or, you may find the features of the [[StringTokenizer class|StringTokenizer]] to be more helpful.</p> | ||
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. | 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. | ||
| Line 33: | Line 33: | ||
$Lstr_Windex is only available in ''[[Sirius Mods]]'' Version 6.5 and later. | $Lstr_Windex is only available in ''[[Sirius Mods]]'' Version 6.5 and later. | ||
==See also== | |||
<ul> | |||
<li><var>[[Word (String function)|Word]]</var> - Select word from list of words | |||
<li><var>[[Words (String function)|Words]]</var> - Sublist of list of words | |||
<li><var>[[WordCount (String function)|WordCount]]</var> - Count words in list | |||
<li><var>[[WordNumberIn and WordNumberOf (String functions)|WordNumberIn and WordNumberOf]]</var> - Word number of "needle" word within "haystack" list of words | |||
</ul> | |||
<p> | <p> | ||
Revision as of 19:49, 27 April 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 $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" />
$Lstr_Windex function
%RESULT is the position of word within longstring.
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
- Sirius functions
- Fast/Unload User Language Interface
- Janus Open Client
- Janus Open Server
- Janus Sockets
- Janus Web Server
- Japanese functions
- Sir2000 Field Migration Facility
Products authorizing $Lstr_Windex