Single-Element Functions : List of Functions : stm_r_xx_all

stm_r_xx_all
Description
Returns both the textual and graphical information associated with a specified element.
Note:  

stm_r_all (id, &status)

Function Type
stm_xx_all_ptr
For Elements
combinational assignment
Syntax
stm_r_xx_all (xx_id, &status)
Arguments
 
Input/Output
Status Codes
Note: When stm_unresolved is returned, a record is received with the fields name, unique name, type, and chart. The remainder of the text fields are empty. The remainder of the graphical fields contain -1.
Example
To retrieve several fields (graphical and textual) attached to a specific state whose ID is st_id, use the first statement to retrieve all the information regarding the specific state (st_id), then extract the particular fields from the record.

 

stm_id st_id;
int status;
stm_st_all_ptr st_record;
stm_element_name name;
stm_short_name synonym;
stm_color color;
.
.
st_record = stm_r_st_all (st_id, &status);
name = st_record->st_name;
synonym = st_record->st_synonym;
color = st_record->st_color;