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_typeid_is_collection() functionThe mi_typeid_is_collection() function determines whether a type identifier is for a collection.

The mi_typeid_is_collection() function

The mi_typeid_is_collection() function determines whether a type identifier is for a collection.

Syntax

mi_boolean mi_typeid_is_collection(typeid_ptr)
   MI_TYPEID *typeid_ptr;

typeid_ptr: A pointer to the type identifier to check.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_typeid_is_collection() function determines if the data type in the type identifier that typeid_ptr references is a collection data type. Valid collection data types are SET, MULTISET, and LIST.

Important: The type identifier is an opaque structure. Do not access its value directly. To determine if a type identifier contains a collection data type, always use mi_typeid_is_collection().

Return values

MI_TRUE: The type identifier that typeid_ptr references is a collection data type.
MI_FALSE: The type identifier that typeid_ptr references is not a collection data type.