Query Functions : Calling Query Functions : Name and Synonym Patterns

Name and Synonym Patterns

The name_of and synonym_of functions search the entire database for elements whose name (or synonym) matches the pattern specified in the argument pattern.

The syntax is as follows:

stm_r_xx_name_of_xx (pattern, status)
stm_r_xx_synonym_of_xx (pattern, status)

In this syntax:

stm_r_—Designates the function as a Statemate database retrieval function
xx—The two-character type abbreviation of elements in the output list
name_of or synonym_of—The criterion to be met (specifies that the query “Element whose name matches a pattern” or “Element whose synonym matches a pattern” is to be applied)
pattern—A character string you supply as an input argument
status—The return function status code

For example:

stm_r_ev_name_of_ev (’EV*’, status)

This function returns all events from the database whose names begin with the string EV.