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_maxlength() functionThe mi_type_maxlength() function obtains the maximum length of a data type from its type descriptor.

The mi_type_maxlength() function

The mi_type_maxlength() function obtains the maximum length of a data type from its type descriptor.

Syntax

mi_integer mi_type_maxlength(type_desc)
   MI_TYPE_DESC *type_desc;

type_desc: A pointer to the type descriptor from which to obtain the maximum length.


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

Usage

The mi_type_maxlength() function obtains the maximum length of the data type from the type descriptor that type_desc references. The maximum length applies to the built-in data types VARCHAR and LVARCHAR. For extended data types, the maximum length is the value of the maxlen column of the sysxtdtypes system catalog table.

For GLS, the NVARCHAR data type also has a maximum length.

If you call mi_type_maxlength() on some other data type, the function returns zero.

Return values

>=0: The maximum length of the data type in the type_desc type descriptor.
MI_ERROR: The function was not successful.