$Abbrev: Difference between revisions

Revision as of 00:37, 26 October 2012

Determine if string is abbreviation within list of words

Most Sirius $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO equivalent for the $Abbrev function.

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

$Abbrev accepts two arguments and returns a numeric code.

The first argument is a list of blank-delimited words.

The second argument is the word to be compared with the blank-delimited word list in the first argument.

<section begin="syntax" />%result = $Abbrev(word_list, string) <section end="syntax" />

%result indicates the relative position in word_list of the first word for which string is a valid abbreviation.

>0 - Number of matching word 0 - No matches found -1 - First parameter missing or null -2 - Second parameter missing or null

$Abbrev return codes

In the following example

%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'B')

%NUM is set to 2.

In the following example

%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'M')

%NUM is set to 3.

In the following example

%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'MU')

%NUM is set to 4.

In the following example

%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'TOP')

%NUM is set to 1.

In the following example

%NUM = $Abbrev('TOP BOTTOM MIDDLE MUDDLE', 'MAD')

%NUM is set to 0.

@@ Line 16: / Line 16: @@
 <section end="syntax" /></p>
-<p class="caption">%result indicates the relative position in word_list of the first word for which string is a valid abbreviation.</p>
+<p>%result indicates the relative position in word_list of the first word for which string is a valid abbreviation.</p>
 <p class="code">
   >0 - Number of matching word