The mi_type_byvalue() function
The mi_type_byvalue() function checks a type descriptor to determine whether a data type is passed by value or by reference.
Syntax
mi_boolean mi_type_byvalue(type_desc)
MI_TYPE_DESC *type_desc;- type_desc
- A pointer to the type descriptor from which to determine the passing mechanism of a data type.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| Yes | Yes |
Usage
The mi_type_byvalue() function determines the passing mechanism for the data type that type_desc references. For extended data types, the value that mi_type_byvalue() returns comes from the byvalue column of the sysxtdtypes system catalog table.
Use this function to determine whether a particular MI_DATUM value (such as a routine argument or return value) is passed by value or by reference.
Return values
- MI_TRUE
- The data type is passed by value.
- MI_FALSE
- The data type is not passed by value; it is passed by reference.