Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

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

void *mi_fp_funcstate(fparam_ptr)

MI_FPARAM *fparam_ptr;

fparam_ptr

is a pointer to the associated MI_FPARAM structure.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

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;

See the descriptions of the following functions: mi_fp_argisnull(), mi_fp_arglen(), mi_fp_argprec(), mi_fp_argscale(), mi_fp_argtype(), mi_fp_retlen(), mi_fp_retprec(), mi_fp_retscale(), mi_fp_rettype(), mi_fp_returnisnull(), and mi_fp_setfuncstate().