The mi_fparam_free() function

The mi_fparam_free() function deallocates resources used by an MI_FPARAM structure allocated on behalf of a user-defined routine.

Syntax

mi_integer mi_fparam_free(fparam_ptr)
   MI_FPARAM *fparam_ptr;
fparam_ptr
A pointer to the MI_FPARAM structure for which to deallocate resources.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes

Usage

The mi_fparam_free() function is the destructor function for the MI_FPARAM structure. Use the mi_fparam_free() function to free only those MI_FPARAM structures that have been allocated on behalf of user-defined routines with mi_fparam_allocate() or mi_fparam_copy().
Important: The mi_fparam_free() function generates an error if you attempt to free an MI_FPARAM structure that the database server has allocated.

It is an error to call this function to free an MI_FPARAM structure that the database server allocated internally.

For more information about how to use an MI_FPARAM structure, see the Informix® DataBlade® API Programmer's Guide.

Return values

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