$Lstr Words: Difference between revisions
mNo edit summary |
mNo edit summary |
||
Line 2: | Line 2: | ||
<span class="pageSubtitle"><section begin="desc" />Return the number of words in a long string<section end="desc" /></span> | <span class="pageSubtitle"><section begin="desc" />Return the number of words in 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_Words</var> is <var>[[WordCount (String function)|WordCount]]</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 30: | Line 30: | ||
$Lstr_Words is only available in ''[[Sirius Mods]]'' Version 6.5 and later. | $Lstr_Words 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:48, 27 April 2011
<section begin="desc" />Return the number of words in a long string<section end="desc" />
Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for $Lstr_Words is WordCount. 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_Words function accepts two arguments and returns a string result.
The first argument is an arbitrary string or longstring. This is a required argument.
The second 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_Words(longstring, delims) <section end="syntax" />
For example, the following statement sets %RES to 8:
%RES = $Lstr_Words('Picture yourself in a boat on a river')
This statement sets %RES to 7:
%RES = $Lstr_Words('Picture yourself in a boat on a river', 'a ')
$Lstr_Words 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