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_get_parameter_info() functionThe mi_get_parameter_info() function populates a parameter-information descriptor with the current session parameters.

The mi_get_parameter_info() function

The mi_get_parameter_info() function populates a parameter-information descriptor with the current session parameters.

Syntax

mi_integer mi_get_parameter_info (parameter_info)
   MI_PARAMETER_INFO *parameter_info;

parameter_info: A pointer to a user-provided parameter-information descriptor to store the current session parameters.


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

Usage

The mi_get_parameter_info() function returns current session parameters into the parameter-information descriptor (MI_PARAMETER_INFO structure) that parameter_info references. The parameter information structure controls whether callbacks are enabled and whether pointers are checked during the session.

Tip: You must allocate this parameter-information descriptor before you call mi_get_parameter_info().

The mi_get_parameter_info() function also initializes the DataBlade® API when it is the first DataBlade API function in a client LIBMI application.

To set the session parameters, use the mi_get_parameter_info() function.

For more information about the parameter-information descriptor, see the HCL OneDB™ DataBlade API Programmer's Guide.

Return values

MI_OK: The function was successful.
MI_ERROR: The function was not successful.