Obtain additional routine information

The MI_FPARAM structure of a C UDR provides additional information about a UDR.

The following table lists the DataBlade® API accessor functions that obtain and set other routine information of a UDR.
Table 1. Other routine information in the MI_FPARAM structure
Routine information DataBlade API accessor function
The name of the UDR mi_fp_funcname()
The iterator status for this iteration of an iterator function

Values are SET_INIT, SET_RETONE, and SET_END.

 mi_fp_request()
The iterator-completion flag, which indicates whether an iterator function has finished returning rows of data mi_fp_setisdone()
The identifier of the UDR with which the MI_FPARAM structure is associated mi_fp_getfuncid(), mi_fp_setfuncid()
The MI_FPARAM structure of the UDR

A UDR needs to obtain the address of its MI_FPARAM structure only in special cases. For more information, see the description of the accessor function.

 mi_fparam_get_current()
The column identifier associated with the UDR

A UDR needs to access its column identifier only in special cases. For more information, see the description of the accessor function.

 mi_fp_getcolid(), mi_fp_setcolid()
The row structure associated with the UDR

A UDR needs to access its row structure only in special cases. For more information, see the description of the accessor function.

 mi_fp_getrow(), mi_fp_setrow()