The mi_fparam_get_current() function
The mi_fparam_get_current() function obtains the MI_FPARAM structure for the currently running user-defined routine (UDR).
Syntax
MI_FPARAM *mi_fparam_get_current(void)
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
No | Yes |
Usage
The mi_fparam_get_current() function obtains the MI_FPARAM structure for the current UDR. When the routine manager invokes a UDR, it passes this MI_FPARAM structure as that last argument to the UDR. This function is valid only within a UDR call. It returns the NULL-valued pointer if called from a callback (such as an end-of-statement callback) that is not strictly called from a UDR.
For more information about how to declare an MI_FPARAM argument or how to obtain routine information for a UDR, see the HCL OneDB™ DataBlade API Programmer's Guide.
Return values
- An MI_FPARAM pointer
- A pointer that references the MI_FPARAM structure for the current UDR.
- NULL
- The function was not successful or that it was called from a callback that was not strictly called from a UDR.