Utility Functions : Calling Utility Functions : Contains Element

Contains Element

The contains_element function returns a Boolean value of TRUE if the item of interest is contained in the list (and FALSE if not contained).

The syntax is as follows:

stm_list_contains_element (list, item, status)

In this syntax:

stm_list—Designates the function as a Statemate list manipulation function.
contains_element—Signifies that this function checks to see whether the specified item is a member of the list.
list—Is the list in which to search for the specified item. list can be any DGL list type (for example, LIST OF ELEMENT).
item—Is an item whose presence in the list you want to verify. The data type of the item must be compatible with list’s data type.
status—Is the return function status code.

For example:

stm_list_contains_element (state_list, state_id, status)

This function returns a value of TRUE if the state whose ID is state_id is a member of the list state_list.