Utility Functions : Calling Utility Functions : List Extraction by Type

List Extraction by Type

The list_extraction_by_type function extracts the Statemate elements in the input list that are of a particular data type.

The syntax is as follows:

stm_list_extraction_by_type (element_type, list, status)

In this syntax:

stm_list—Designates the function as a Statemate list manipulation function.
extraction_by_type—Signifies that this function extracts all Statemate elements of a specified type from the input list.
element_type—Is a Statemate element type predefined constant.
list—Is the list in which to search for elements of the specified type. list can contain a variety of Statemate elements (a mixed list).
status—Is the return function status code.

For example:

stm_list_extraction_by_type (stm_state, elmnt_list, status);

This call extracts all states from the list assigned to the variable elmnt_list. stm_state is one of the predefined constants that designates an element type.