The mi_fparam_allocate() function

The mi_fparam_allocate() function allocates an MI_FPARAM structure and returns a pointer to this structure.

Syntax

MI_FPARAM *mi_fparam_allocate(nargs)
   mi_integer nargs;
nargs
The number of arguments that the new MI_FPARAM structure can hold.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes

Usage

The mi_fparam_allocate() function is a constructor function for the MI_FPARAM structure. It allocates an MI_FPARAM structure that holds information for nargs arguments. Use this function for the MI_FPARAM structure that Fastpath look-up functions allocate.

Server only: The mi_fparam_allocate() function allocates a new MI_FPARAM structure in the PER_COMMAND memory duration.

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

Return values

An MI_FPARAM pointer
A pointer to the MI_FPARAM structure for which mi_fparam_allocate() has allocated memory.
NULL
The function was not successful.