The MI_FPARAM function argument

BladeSmith adds an extra argument to all routines it generates: a pointer to an MI_FPARAM structure.

However, except for iterator functions and user-defined functions that allow null arguments, the generated code does not manipulate the values stored in MI_FPARAM structures. The MI_FPARAM argument is included for your convenience. If you want to use the MI_FPARAM structure, you must add code to all noniterator routines.

Typically, you only need to use the MI_FPARAM structure for the following tasks:
  • Check for NULL arguments or return values
  • Set arguments or return values to NULL
  • Get data type information about arguments or return values
  • Manage iterative calls to a function

To manipulate the values in an MI_FPARAM structure, you must use its DataBlade® API accessor functions. Do not access MI_FPARAM structure members directly, because the structure might change between versions of the DataBlade API.

In addition to references for each of the MI_FPARAM accessor functions, the HCL OneDB™ DataBlade API Programmer's Guide includes a section that describes the information stored in the MI_FPARAM structure and tells you how to get values from or store values in the structure and how to use the structure for creating iterative functions.

For an explanation of how generated code uses the MI_FPARAM structure in an iterator function, see Iterator functions. The ExmAmortize() function in the example Business DataBlade module uses the MI_FPARAM structure in an iterative function.