Single-Element Functions : List of Functions : stm_r_xx_text

stm_r_xx_text
Returns the textual information associated with a specified element.
You can call this function without indicating the specific element type:

stm_r_text(id,&status)

The information is retrieved into a structured data type (record), which varies according to the type of element referenced.
Function Type
stm_xx_text_ptr
For Elements
combinational assignment
Syntax
stm_r_xx_text (xx_id, &status)
Arguments
 
Input/Output
Status Codes
stm_illegal_parameter —When this status code is returned, a record is received with the fields name, unique name, type, and chart. The rest of the text fields are empty.
Example
To retrieve several fields attached to a specific state whose ID is st_id, use the first statement. Thereafter, extract from this record the particular fields.

 

stm_id st_id;
int status;
stm_st_text_ptr st_record;
stm_element_name name;
stm_short_name synonym;
.
.
st_record = stm_r_st_text (st_id, &status);
.
name = st_record->st_name;
synonym = st_record->st_synonym;
.
.

When retrieved, the information is assigned to a specific record that can be examined thereafter for the desired information.