Arbortext Command Language > Functions by Alphabetical Listing > lookup_replacements
  
lookup_replacements
lookup_replacements (index, replacements[], typeFlag = 0x01)
This function retrieves the possible replacements for the definition of the word specified in the previous call to the lookup function. If there was no previous call or the word was not found, then 0 is returned. Otherwise the number of replacements is returned.
index is the numeric index for the definition returned in the previous call to the lookup function or 0 if a list of suggestions is requested.
replacements is a numeric indexed array containing the possible replacement words.
typeFlag is one of the following flags to specify the type of replacement:
0x01 — Synonym
0x02 — Compared
0x04 — Related
0x08 — Contrast
0x10 — Antonym
index is the numeric index for the definition returned in the previous call to the lookup function.