Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_fparam_free() functionThe mi_fparam_free() function deallocates resources used by an MI_FPARAM structure allocated on behalf of a user-defined routine.

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 HCL OneDB™ DataBlade® API Programmer's Guide.

Return values

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