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_setargtype() functionThe mi_fp_setargtype() accessor routine sets the type identifier for the data type of an argument of a user-defined routine in its associated MI_FPARAM structure.

The mi_fp_setargtype() function

The mi_fp_setargtype() accessor routine sets the type identifier for the data type of an argument of a user-defined routine in its associated MI_FPARAM structure.

Syntax

void mi_fp_setargtype(fparam_ptr, arg_pos, arg_typeid)
   MI_FPARAM *fparam_ptr;
   mi_integer arg_pos;
   MI_TYPEID *arg_typeid;

fparam_ptr: A pointer to the associated MI_FPARAM structure.
arg_pos: The index position into the argument-type array for the argument whose type identifier you want to set.
arg_typeid: A pointer to the type identifier that specifies the data type to set for the arg_pos + 1 argument.


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

Usage

The mi_fp_setargtype() function sets the type identifier of the routine argument at position arg_pos in the MI_FPARAM structure that fparam_ptr references. The type identifier indicates a particular data type. The MI_FPARAM structure stores information about the type identifiers of routine arguments in the zero-based argument-type array. To set information about the nth argument, use an arg_pos value of n-1.

For example, the following call to mi_fp_setargtype() obtains the type identifier for the third argument of the my_func() UDR, with which fparam1 is associated:

mi_integer my_func(..., fparam1)
   ...
   MI_FPARAM *fparam1;
{
   MI_TYPEID *arg_type;
   ...
   arg_type = mi_type_
   mi_fp_setargtype(fparam1, 2, arg_type);

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

Return values

None.