Single-Element Functions : List of Functions : stm_r_xx_description

stm_r_xx_description
Returns the short description of the specified element. The short description is defined in the element’s form.
You can call this function without indicating the specific element type:

stm_r_description (id, &status)

Function Type
stm_description
For Elements
 
subroutine parameter
Syntax
stm_r_xx_description (xx_id, &status)
Arguments
 
Input/Output
If no description exists in the element’s form, status receives the value stm_missing_short_description.
Status Codes
Example
To retrieve the contents of the short description field in the form of state SSS.S1, use the following statements.

 

stm_id state_id;
stm_description state_desc;
int status;
.
.
state_id = stm_r_st ("SSS.S1", &status);
state_desc = stm_r_st_description (state_id, &status);
.
.
.

state_desc contains the short description for the state SSS.S1 (whose ID is state_id).