Documentor Functions : Calling Conventions : Function Return Values

Function Return Values

Database extraction functions return values that are of DGL data types (see Data-types for more information). Different functions return different types of values. For example, a function that retrieves the name of a Rational Statemate element returns a value of type STRING, whereas a function that retrieves a state’s ID returns a value of type STATE (or ELEMENT).

The return value data type must be valid when the function is used in statements and expressions. For example, a return value that is a STRING can appear in places where string expressions are allowed, as shown in the following WRITE statement:

WRITE (stm_r_st_name (st_id, status));

This statement prints out the name of the state whose ID is st_id. The return values of each function are listed in the sections that describe the specific functions.