Utility Functions : Calling List Utility Functions

Calling List Utility Functions

Most of the utility functions operate on lists using the following calling sequence:

stm_list_operation (list, &status);

In this syntax:

stm_list—Designates the function as a Rational 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 Rational 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.

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