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_routine_id_get() functionThe mi_routine_id_get() accessor function returns the routine identifier for the user-defined routine that the specified function descriptor describes.

The mi_routine_id_get() function

The mi_routine_id_get() accessor function returns the routine identifier for the user-defined routine that the specified function descriptor describes.

Syntax

mi_integer mi_routine_id_get(conn, funcdesc_ptr)
   MI_CONNECTION *conn;
   MI_FUNC_DESC *funcdesc_ptr;

conn: A pointer to a connection descriptor established by a previous call to mi_open(), mi_server_connect(), or mi_server_reconnect().
funcdesc_ptr: A pointer to a function descriptor for a user-defined routine.


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

Usage

The mi_routine_id_get() function is one of the DataBlade® API functions of the Fastpath interface. It returns the routine identifier for the UDR that the funcdesc_ptr function descriptor describes. The routine identifier uniquely identifies a user-defined routine. The database server generates this identifier and stores it in the procid column of the sysprocedures system catalog table.

Tip: The DataBlade API provides the mi_funcid data type for routine identifiers. The mi_funcid data type has the same structure as the mi_integer data type. For compatibility with earlier versions, mi_routine_id_get() continues to return a routine identifier as an mi_integer value.

Return values

>=0: The routine identifier of the routine that funcdesc_ptr identifies.
MI_ERROR: The function was not successful.