View source for $Word

<p>The $WORD function searches a string from the left for a complete word and returns the nth word in a specified string, delimited by a blank or optionally specified character.</p>
<b>Syntax</b>
<p>The format of the $WORD function is:</p>
<p class="code">$WORD('inputstring',['delimiter'],<var>[</var>n<var>]</var>)
</p>
<p>where:</p>
<ul>
<li>inputstring is the input from which the specified word is to be extracted. inputstring can be a quoted literal or a %variable.</li>
</li>
<li>delimiter is an optional quoted character or string to be used as a delimiter in parsing the input string into words. If delimiter is not specified, it defaults to a blank space. If delimiter consists of more than one character, <var class="product">Model&nbsp;204</var> uses the first character in the string as the delimiter.</li>
</li>
<li>n is the ordinal number of the word to be extracted. $WORD returns a null string under any of the following conditions:</li>
</li>
</ul>
<p>n is not specified</p>
<p>n is less than 1 (0 or negative)</p>
<p>n is greater than the number of words in inputstring</p>
<p>The commas which separate the three arguments are required, even if delimiter is not specified.</p>
<b>Usage</b>
<p>Null values between delimiters are not considered words. For example, </p>
<p class="code">$WORD('=ABCD==D=XXX','=',2)
</p>
<p>returns D as the second word, not a null value.</p>
<b>Examples</b>
<p>The following function returns the third word in the string, "THE", when a single space delimits a word:</p>
<p class="code">$WORD ('NOW IS THE TIME',,3)
</p>
<p>The following function returns the second word in the string, "S THE T", where a word is composed of the characters that precede a delimiting I:</p>
<p class="code">$WORD ('NOW IS THE TIME','I',2)
</p>
[[Category:SOUL $functions]]