Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

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

mi_integer mi_get_connection_user_data(conn, user_data)

MI_CONNECTION *conn;

void **user_data;

conn	is a pointer to the connection descriptor that a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect() has established.
user_data	is a pointer to user information to associate with the specified connection.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

The mi_get_connection_user_data() function places the value of the user data that is associated with the connection that the conn connection descriptor identifies in the pointer that user_data references. The user-state pointer points to a user-defined buffer or structure that contains private information you want to keep with the specified connection.

The size of the connection-user data is the size of a pointer of type "void *" The DataBlade API does not interpret or touch the associated user value, other than to store it internally with the connection. You can set the user data with the mi_set_connection_user_data() function.

See the descriptions of the following functions: mi_get_connection_info(), mi_get_default_connection_info(), mi_get_parameter_info(), and mi_set_connection_user_data().