$Abbrev

From m204wiki
Jump to navigation Jump to search

Determine if string is abbreviation within list of words

Note: Many $functions have been deprecated in favor of Object Oriented methods. There is currently no direct OO equivalent for $Abbrev. However, the IsStartOf function can be used to determine whether one string is an initial substring (abbreviation) of another.

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

Syntax

%result = $Abbrev(word_list, string)

Syntax terms

%result A numeric value that indicates the relative position in word_list of the first word for which string is a valid abbreviation.
word_list A list of blank-delimited words.
string The word to be compared with the word_list argument.

Return codes

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

Examples

  1. In the following example, %NUM is set to 2:

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

  2. In the following example, %NUM is set to 3:

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

  3. In the following example, %NUM is set to 4:

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

  4. In the following example, %NUM is set to 1:

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

  5. In the following example, %NUM is set to 0:

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

Products authorizing $Abbrev