informix
Informix DataBlade API Programmer's Manual
DataBlade API Function Descriptions

mi_get_parameter_info()

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

Syntax

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_set_parameter_info() function.

Return Values

MI_OK indicates that the function was successful.
MI_ERROR indicates that the function was not successful.

Related Topics

See the description of the following functions: mi_get_connection_info(), mi_get_database_info(), mi_get_serverenv(), and mi_set_parameter_info().

For additional information on the parameter-information descriptor, see Using Session Parameters.


Informix DataBlade API Programmer's Manual, Version 9.2
Copyright © 1999, Informix Software, Inc. All rights reserved