Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_type_byvalue() functionThe mi_type_byvalue() function checks a type descriptor to determine whether a data type is passed by value or by reference.

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.