Home
Extending HCL OneDB™Beyond standard relational database objects, HCL OneDB™ can be extended to handle specialized data types, access methods, routines, and other objects. HCL OneDB™ includes many built-in extensions that are fully integrated in the database server. HCL OneDB™ also provides DataBlade® modules, which are packages of extended database objects for a particular purpose and that are installed separately from the database server. Alternatively, you can create your own user-defined objects for HCL OneDB™.
Creating extensionsYou can create user-defined data types, routines, access methods, and other database objects to suit your needs. You can use application programming interfaces to write user-defined routines and applications that access data in HCL OneDB™ databases.
DataBlade® API Function ReferenceThe HCL OneDB™ DataBlade® API Function Reference describes the DataBlade® API functions and the subset of functions that the DataBlade® API supports.
Function descriptionsThis section gives comprehensive reference information about the functions that are valid within DataBlade® API modules. It lists the function descriptions in alphabetical order, with syntax, usage information, and return values for the functions.
The mi_fparam_allocate() functionThe mi_fparam_allocate() function allocates an MI_FPARAM structure and returns a pointer to this structure.

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 HCL OneDB™ 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.