The mi_set_parameter_info() function

The mi_set_parameter_info() function sets the session parameters with values from a parameter-information descriptor that the user provides.

Syntax

mi_integer mi_set_parameter_info(sess_info)
   const MI_PARAMETER_INFO *sess_info;;
sess_info
A pointer to a user-provided parameter-information descriptor from which to set the current session parameters.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes

Usage

The mi_set_parameter_info() function sets the session parameters with the fields in the parameter-information descriptor (MI_PARAMETER_INFO structure) that sess_info references. The parameter-information descriptor determines whether callbacks are enabled and whether pointers are checked during the session. You must allocate this parameter-information descriptor before you call mi_set_parameter_info().

The mi_set_parameter_info() function also initializes the DataBlade® API when it is the first DataBlade® API function in a client LIBMI application or a user-defined routine.

To obtain the session parameters, use the mi_set_parameter_info() function.

For more information about the parameter-information descriptor, see the Informix® DataBlade® API Programmer's Guide.

Return values

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