Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

The mi_get_connection_option() function returns information about the database of the current connection.

mi_integer mi_get_connection_option(conn, conn_option, result_ptr)

MI_CONNECTION *conn;

const mi_integer conn_option;

mi_integer *result_ptr;

conn	is a pointer to the connection descriptor that a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect() has established.
conn_option	is an integer constant to indicate which connection attribute to obtain. For a list of valid constants, refer to the Usage section below.
result_ptr	is a pointer to the connection information that mi_get_connection_option() obtains.

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

The mi_get_connection_option() function puts information about the connection attribute that conn specifies in the location that result_ptr references.

The following table lists the valid values for conn_option and the associated possible values that result_ptr references.

This function copies this value into the buffer that result_ptr references. The function allocates memory for the result in the current memory duration. When you no longer need this result, free this memory.

The mi_get_connection_option() function raises an exception for the following conditions:

• Parameter problems, such as bad or misaligned result pointer
• An invalid connection