The mi_class_id() function
The mi_class_id() function obtains the VP-class identifier for a specified virtual-processor (VP) class.
Syntax
mi_integer mi_class_id(VPclass_name)
const char *VP_classname;- VP_classname
- A pointer to the name of the VP class whose VP-class identifier the function is to return.
| 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_class_id() function
returns the VP-class identifier for the VP-class name that VPclass_name references.
The VP-class name is not case-sensitive; that is, either uppercase
or lowercase letters are valid.
Tip: You can obtain the
VP-class identifier for the active VP with the mi_vpinfo_classid() function.
After
you have a VP-class identifier, you can use the following DataBlade API functions
to obtain additional information about the VP class.
- 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 how to obtain information about VPs and VP classes, see the HCL OneDB™ DataBlade API Programmer's Guide.
Return values
- >=0
- The integer VP-class identifier for the VP class associated with the specified VP-class name.
- MI_ERROR
- The function was not successful.