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_connection_user_data() functionThe mi_get_connection_user_data() function obtains the address of user data associated with an open connection.

The mi_get_connection_user_data() function

The mi_get_connection_user_data() function obtains the address of user data associated with an open connection.

Syntax

mi_integer mi_get_connection_user_data(conn, user_data_ptr)
   MI_CONNECTION *conn;
   void **user_data_ptr;

conn: A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().
This value can be a pointer to a session-duration connection descriptor established by a previous call to mi_get_session_connection(). Use of a session-duration connection descriptor is an advanced feature of the DataBlade® API.
user_data_ptr: The address of the user-data pointer that is associated with the specified connection.


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

Usage

The mi_get_connection_user_data() function obtains the address of the user-data pointer, which user_data_ptr references, from the connection descriptor that conn references. The user-data pointer is the address to a user-defined buffer or structure that contains private information you want to keep with the specified connection.

The DataBlade API does not interpret or touch the associated user-data pointer, other than to retrieve it from the connection descriptor. Cast the user_data_ptr pointer from void ** to the address of the user-data pointer for the data structure before you use it as the user-data pointer in a DataBlade API module.

You can set the user-data pointer with the mi_set_connection_user_data() function.

Return values

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