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_funcarg_get_datalen() functionThe mi_funcarg_get_datalen() function returns the data length of an argument for the companion UDR of a cost or selectivity function.

The mi_funcarg_get_datalen() function

The mi_funcarg_get_datalen() function returns the data length of an argument for the companion UDR of a cost or selectivity function.

Syntax

mi_integer mi_funcarg_get_datalen(funcarg_ptr)
   MI_FUNCARG *funcarg_ptr;

funcarg_ptr: A pointer to the MI_FUNCARG structure that describes the companion-UDR argument.


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

Usage

The mi_funcarg_get_datalen() function returns the data length of the argument from the MI_FUNCARG structure that funcarg_ptr references. The MI_FUNCARG structure describes an argument of a companion UDR to its cost or selectivity function. Use the mi_funcarg_get_datalen() function in a cost or selectivity function to obtain the data length of an argument passed into the expensive UDR.

Return values

>= 0: The data length for the companion-UDR argument.
MI_ERROR: The function was not successful.