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_fp_nargs() functionThe mi_fp_nargs() accessor function obtains the number of arguments for the UDR routine from its associated MI_FPARAM structure.

The mi_fp_nargs() function

The mi_fp_nargs() accessor function obtains the number of arguments for the UDR routine from its associated MI_FPARAM structure.

Syntax

mi_integer mi_fp_nargs(fparam_ptr)
   MI_FPARAM *fparam_ptr;

fparam_ptr: A pointer to the associated MI_FPARAM structure.


Valid in client LIBMI application?	Valid in user-defined routine?
Yes	Yes

Usage

You can use the mi_fp_nargs() function with the DataBlade® API functions that obtain information about each argument of the UDR routine (such as mi_fp_argtype() and mi_fp_argisnull()). For example, the following call to mi_fp_nargs() obtains the number of arguments from the MI_FPARAM structure that fparam1 identifies and uses the value in a loop to obtain the length of each argument:

arg_count = mi_fp_nargs(fparam1);
for (i = 0; i < arg_count; i++)
   {
   arg_len[i] = mi_fp_arglen(fparam1, i);

For more information about argument information in an MI_FPARAM structure, see the HCL OneDB™ DataBlade API Programmer's Guide.

Return values

>=0: The number of arguments with which the UDR was called.
MI_ERROR: The function was not successful.