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_fp_funcstate() functionThe mi_fp_funcstate() accessor function obtains user-state information for the user-defined routine from its associated MI_FPARAM structure.

The mi_fp_funcstate() function

The mi_fp_funcstate() accessor function obtains user-state information for the user-defined routine from its associated MI_FPARAM structure.

Syntax

void *mi_fp_funcstate(fparam_ptr)
   MI_FPARAM *fparam_ptr;

fparam_ptr: A pointer to the associated MI_FPARAM structure.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

The mi_fp_funcstate() function obtains a pointer to the user-state information for the user-defined routine that is associated with the fparam_ptr MI_FPARAM structure. In the first invocation of the UDR, the database server sets the user-state pointer to NULL. Use the mi_fp_funcstate() function to return the user-state pointer so that you can access the state information within a UDR.

Cast this user-state pointer to match the structure of the user-defined buffer. For example, the following call to mi_fp_funcstate() casts the user-state pointer as a structure called udr_info and uses this pointer to access the count_fld of the udr_info structure:

MI_FPARAM *my_fparam;
struct udr_info *fi_ptr;
mi_integer count;
...
fi_ptr = (udr_info *)mi_fp_funcstate( my_fparam );
count = fi_ptr->count_fld;

For more information about UDR information in an MI_FPARAM structure, see the HCL OneDB™ DataBlade® API Programmer's Guide.

Return values

A user-state pointer: A pointer that references the user-state information in a user-defined buffer. Cast this pointer to match the structure of the user-state information.
NULL: The user-state pointer is uninitialized. The user-state pointer has a NULL value the first time a UDR is invoked.