View source for $Abbrev

{{DISPLAYTITLE:$Abbrev}}
<span class="pageSubtitle">Determine if string is abbreviation within list of words</span>

<p class="warn"><b>Note:</b> <i>Many $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO equivalent for <var>$Abbrev</var>.  However, the <var>[[IsStartOf (String function)|IsStartOf]]</var> function can be used to determine whether one string is an initial substring (abbreviation) of another.</i></p>

This function makes it possible to determine if a string is a valid abbreviation of one of a list of words. 

==Syntax==
<p class="syntax"><span class="term">%result</span> = <span class="literal">$Abbrev</span>(<span class="term">word_list</span>, <span class="term">string</span>)
</p>

===Syntax terms===
<table>
<tr><th>%result</th> 
<td>A numeric value that indicates the relative position in <var class="term">word_list</var> of the first word for which <var class="term">string</var> is a valid abbreviation.</td></tr>

<tr><th>word_list</th> 
<td>A list of blank-delimited words. </td></tr>

<tr><th>string</th> 
<td>The word to be compared with the <var class="term">word_list</var> argument. </td></tr>
</table>

===Return codes===
<p class="code">>0 - Number of matching word
 0 - No matches found
-2 - First parameter missing or null
-1 - Second parameter missing or null
</p>

==Examples==
<ol>
<li>In the following example, %NUM is set to 2:
<p class="code">%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'B')
</p>

<li>In the following example, %NUM is set to 3:
<p class="code">%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'M')
</p>

<li>In the following example, %NUM is set to 4:
<p class="code">%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'MU')
</p>

<li>In the following example, %NUM is set to 1:
<p class="code">%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'TOP')
</p>

<li>In the following example, %NUM is set to 0:
<p class="code">%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'MAD')</p>
</ol>

==Products authorizing {{PAGENAMEE}}== 
 <ul class="smallAndTightList">
<li>[[List of $functions|Sirius functions]]</li>
<li>[[Fast/Unload User Language Interface]]</li>
<li>[[Media:JoclrNew.pdf|Janus Open Client]]</li>
<li>[[Media:JosrvrNew.pdf|Janus Open Server]]</li>
<li>[[Janus Sockets]]</li>
<li>[[Janus Web Server]]</li>
<li>Japanese functions</li>
<li>[[Media:SirfieldNew.pdf|Sir2000 Field Migration Facility]]</li>
</ul>

[[Category:$Functions|$Abbrev]]