Utility Functions : Calling Utility Functions

Calling Utility Functions

The calling sequence of the list functions is as follows:

stm_list_operation (list, status)

In this syntax:

stm_list—Designates the function as a Statemate list manipulation function
operation—The kind of list operation performed
list—The list to be operated on
status—The return function status code

The type of value returned by the function depends on the particular function. The returned value can be a list, a Statemate element, a string, or an integer. For example:

stm_list_sort_by_name (event_list, status)

This function alphabetically sorts the events in event_list according to their names. Function return values for each utility function are listed in Single-Element Functions.

The following sections document the utility functions that use a different calling sequence.