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_getfuncid() functionThe mi_fp_getfuncid() accessor function obtains the routine identifier for a user-defined routine (UDR) in its associated MI_FPARAM structure.

The mi_fp_getfuncid() function

The mi_fp_getfuncid() accessor function obtains the routine identifier for a user-defined routine (UDR) in its associated MI_FPARAM structure.

Syntax

mi_funcid mi_fp_getfuncid(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?
No	Yes

Usage

The mi_fp_getfuncid() function obtains the routine identifier for the user-defined routine that is associated with the fparam_ptr MI_FPARAM structure. The routine identifier uniquely identifies the UDR within the database. This function is useful to determine the name of the UDR that is currently executing or that is about to be called.

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

Return values

>=0: The routine identifier of the UDR associated with the specified MI_FPARAM structure.
MI_ERROR: The function was not successful.