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_statement_row_desc() functionThe mi_get_statement_row_desc() function obtains the row descriptor for a prepared statement.

The mi_get_statement_row_desc() function

The mi_get_statement_row_desc() function obtains the row descriptor for a prepared statement.

Syntax

MI_ROW_DESC *mi_get_statement_row_desc(stmt_desc)
   MI_STATEMENT *stmt_desc;

stmt_desc: A pointer to the statement descriptor for the prepared statement.


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

Usage

The mi_get_statement_row_desc() function obtains the row descriptor from the statement descriptor that stmt_desc references. This row descriptor contains information for the columns in the prepared statement. From this row descriptor, you can use the row-accessor functions to obtain information about the prepared-statement columns.

The row descriptor is valid until one of the following conditions occurs:

The query finishes.
The mi_close() function is called on the connection.

Restriction: Do not use the mi_row_desc_free() function to free the row descriptor that mi_get_statement_row_desc() allocates. Use mi_row_desc_free() only for row descriptors that you allocate with mi_row_desc_create().

Return values

An MI_ROW_DESC pointer: A pointer that corresponds to the input statement.
NULL: The function was not successful.