The mi_fparam_get() function

The mi_fparam_get() function retrieves a pointer to the MI_FPARAM structure that is associated with the function descriptor of a user-defined routine.

Syntax

MI_FPARAM *mi_fparam_get(conn, funcdesc_ptr)
   MI_CONNECTION *conn;
   MI_FUNC_DESC *funcdesc_ptr;
conn
A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().
funcdesc_ptr
A pointer to the function descriptor whose MI_FPARAM structure mi_fparam_get() is to return.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes

Usage

The mi_fparam_get() function returns a pointer to the MI_FPARAM structure that is part of the function descriptor funcdesc_ptr references. Once you obtain the MI_FPARAM structure for a UDR you want to call with the Fastpath interface, you can modify this MI_FPARAM before you execute the UDR with Fastpath. The mi_fparam_get() function is one of the functions of the Fastpath interface.

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

Return values

An MI_FPARAM pointer
A pointer to the MI_FPARAM structure that is associated with the UDR that the specified function descriptor identifies.
NULL
The function was not successful.