Single-Element Functions : List of Functions : stm_r_xx_instance_name

stm_r_xx_instance_name
Returns the name of the instance as it appears in the chart for a specific hierarchical Statemate element.
Note the following:

You can call this function without indicating the specific element type, as follows:

stm_r_instance_name (id, status)

This function is relevant only for states, internal modules, and regular or control activities, because only these elements can have instances.

Function type
STRING
For elements
Syntax

stm_r_xx_instance_name (xx_id, status)

Arguments
Status Codes
Example
To retrieve the name of an instance for state named S1@S1_def, use the following statements:

VARIABLE
STATE state_id;
INTEGER status;
.
.
.
state_id := stm_r_st (’S1’, status);
WRITE (’\n Instance Name:’,
stm_r_st_instance_name (state_id, status));
.
.
.

The name written to the document is S1@S1_DEF.