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_vpinfo_classid() functionThe mi_vpinfo_classid() function obtains the VP-class identifier for the VP class in which the current UDR is running.

The mi_vpinfo_classid() function

The mi_vpinfo_classid() function obtains the VP-class identifier for the VP class in which the current UDR is running.

Syntax

mi_integer mi_vpinfo_classid(void)


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

Important: This advanced function can adversely affect your UDR if you use the function incorrectly. Use it only when no regular DataBlade® API function can perform the task you need done.

Usage

The mi_vpinfo_classid() function returns the VP-class identifier for the current VP. The current VP is the VP on which the current UDR is running. The VP-class identifier is a unique integer that the database server assigns to each defined VP class.

Tip: You can obtain the VP-class identifier for a specified VP with the mi_class_id() function.

After you have a VP-class identifier, you can use the following DataBlade API functions to obtain additional information about the VP class.

DataBlade API function: VP-class information
mi_class_name(): VP-class name
mi_class_maxvps(): Maximum number of VPs in the VP class
mi_class_numvp(): Number of active VPs in the VP class

For information about VPs and VP classes, see the HCL OneDB™ DataBlade API Programmer's Guide.

Return values

>=0: The VP-class integer for the VP class in which the current UDR is running.
MI_ERROR: The function was not successful.

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box.