Home | Previous Page | Next Page   Function Descriptions >

mi_fparam_get( )

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
is a pointer to a connection descriptor established by a previous call to mi_open( ), mi_server_connect( ), or mi_server_reconnect( ).
funcdesc_ptr
is 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 description 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.

Return Values

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

Related Topics

See also the descriptions of mi_fparam_get_current( ), mi_func_handlesnulls( ), mi_func_isvariant( ), mi_func_negator( ), and mi_routine_id_get( ).

For more information about how to use an MI_FPARAM structure, see the IBM Informix: DataBlade API Programmer's Guide.

Home | [ Top of Page | Previous Page | Next Page | Contents | Index ]