$Windex: Difference between revisions
m (1 revision) |
EllieWiccan (talk | contribs) (Automatically generated page update) |
||
| (14 intermediate revisions by 4 users not shown) | |||
| Line 3: | Line 3: | ||
<span class="warning"><b>Note:</b></span> | <span class="warning"><b>Note:</b></span> Many $functions have been deprecated in favor of Object Oriented methods. The recommended OO replacement function for <var>$Windex</var> is <var>[[WordNumberIn (String function)|WordNumberIn]]</var>. However, unlike <var>$Windex</var>, <var>WordNumberIn</var> is Longstring capable (like all OO methods), so '''do not''' replace <var>WordNumberIn</var> with <var>$Windex</var>. Note also that in some cases the [[StringTokenizer class|StringTokenizer]] may be a better OO solution. | ||
| Line 17: | Line 17: | ||
==Syntax== | ==Syntax== | ||
<p class="syntax">< | <p class="syntax"><span class="term">%NUM</span> = <span class="literal">$Windex</span>(<span class="term">string</span>, <span class="term">word</span>, [<span class="term">delim</span>]) | ||
< | </p> | ||
<p> | <p> | ||
< | <var class="term">%NUM</var> is either a word number or 0.</p> | ||
< | |||
==Examples== | ==Examples== | ||
| Line 40: | Line 40: | ||
==Products authorizing {{PAGENAMEE}}== | ==Products authorizing {{PAGENAMEE}}== | ||
<ul class="smallAndTightList"> | <ul class="smallAndTightList"> | ||
<li>[[Sirius functions]]</li> | <li>[[List of $functions|Sirius functions]]</li> | ||
<li>[[Fast/Unload User Language Interface]]</li> | <li>[[Fast/Unload User Language Interface]]</li> | ||
<li>[[Janus Open Client]]</li> | <li>[[Media:JoclrNew.pdf|Janus Open Client]]</li> | ||
<li>[[Janus Open Server]]</li> | <li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li> | ||
<li>[[Janus Sockets]]</li> | <li>[[Janus Sockets]]</li> | ||
<li>[[Janus Web Server]]</li> | <li>[[Janus Web Server]]</li> | ||
<li> | <li>Japanese functions</li> | ||
<li>[[Sir2000 Field Migration Facility]]</li> | <li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li> | ||
</ul> | </ul> | ||
[[Category:$Functions|$Windex]] | [[Category:$Functions|$Windex]] | ||
Latest revision as of 23:31, 20 September 2018
Word number of first occurrence of word in phrase
Note: Many $functions have been deprecated in favor of Object Oriented methods. The recommended OO replacement function for $Windex is WordNumberIn. However, unlike $Windex, WordNumberIn is Longstring capable (like all OO methods), so do not replace WordNumberIn with $Windex. Note also that in some cases the StringTokenizer may be a better OO solution.
$Windex finds the first occurrence of a word in a phrase.
The $Windex function accepts three arguments and returns a numeric result that is the word number in the first argument string of the the second argument word.
The first argument is an arbitrary string.
The second argument is word that is to be located in the first argument. If the second argument string is not found, $Windex returns a 0.
The third argument is a delimiter that separates words in the first argument string. This is an optional argument and defaults to blank.
Syntax
%NUM = $Windex(string, word, [delim])
%NUM is either a word number or 0.
Examples
For example, this statement sets %JUNK to 3:
%JUNK = $Windex('BOB CAROL TED ALICE', 'TED')
This statement sets %JUNK to 0:
%JUNK = $Windex('BOB CAROL TED ALICE', 'ROGER')
This statement sets %JUNK to 2:
%JUNK = $Windex('A WORD/OR TWO/BEFORE/I/GO', 'OR TWO', '/')