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 Informix® 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.