Single-Element Functions : List of Functions : stm_r_xx_longdes

stm_r_xx_longdes
Retrieves the long description attached to the specified element.
You can call this function without indicating the specific element type:

stm_r_longdes (id, filename, &status)

Function Type
char *
For Elements
Syntax
stm_r_xx_longdes (xx_id, filename, &status)
Arguments
Input/Output
The filename follows the conventions of the host operating system.
This function returns the value of the argument filename when one is specified. If an empty string ’’(two contiguous quotation marks) is specified, Rational Statemate creates a temporary file where it stores the text. The name of this temporary file is returned by the function.
If no long description exists for the element, status receives the value stm_missing_long_description.
Status Codes
Example
To retrieve the long description for the activity A1, use the following statements:

 

stm_id act_id;
stm_filename long_des_file;
int status;
.
.
act_id = stm_r_ac ("A1", &status);
long_des_file = stm_r_ac_longdes (act_id, "text.txt",
&status);
.
.
.

The long description for the activity A1 is written to the system file text.txt. This file resides in the directory that is the current workarea. The variable long_des_file contains the string ’text.txt’ following statement execution.