Query Functions : Calling Query Functions : By Structure Type

By Structure Type

The by_structure_type function returns all elements in the input list that have a structure type xx_structure_type.

The syntax of the by_structure_type function is as follows:

stm_r_xx_by_structure_type_xx (xx_list, xx_structure_type, &status)
 

In this syntax:

stm_r_—Designates the function as a Rational Statemate database retrieval function
xx—The two-character type abbreviation for elements in the input and output list
by_structure_type—The structure type referenced
xx_list—The input list to the function
xx_structure_type—The structure type referenced (array, single, or queue in the element’s form)
status—The return function status code

For example:

stm_r_di_by_structure_type_di (di_list, stm_di_array, &status)

 

This function returns all data items in di_list that have an array structure type.