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_setnrets() functionThe mi_fp_setnrets() accessor function sets the number of return values for the user-defined function in its associated MI_FPARAM structure.

The mi_fp_setnrets() function

The mi_fp_setnrets() accessor function sets the number of return values for the user-defined function in its associated MI_FPARAM structure.

Syntax

void mi_fp_setnrets(fparam_ptr, ret_num)
   MI_FPARAM *fparam_ptr;
   mi_integer ret_num;

fparam_ptr: A pointer to the associated MI_FPARAM structure.
ret_num: The integer number of return values to store in the MI_FPARAM structure.


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

Usage

The mi_fp_setnrets() function sets the number of return values for a C UDR associated with the MI_FPARAM structure that fparam_ptr references to the value in ret_num.

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

Important: C user-defined functions have only one return value.

Return values

None.