The mi_class_name() function

The mi_class_name() function obtains the name of a virtual-processor (VP) class.

Syntax

char *mi_class_name(VPclass_id)
   mi_integer VPclass_id;
VPclass_id
A VP-class identifier for the VP class whose name the function is to return. This argument can be either of the following values:
A valid VP-class identifier
Obtains the name of the specified VP class.
MI_CURRENT_CLASS VP-class constant
Obtains the name of the VP class of the current VP.
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_name() function obtains the name of the VP class that VPclass_id specifies. The VP-class name is assigned to the VP class in the VPCLASS configuration parameter. For example, suppose you have the following VPCLASS configuration parameter:
VPCLASS=newvp, num=3, max=6

The mi_class_name() function returns the string 'newvp' when it receives the VP-class identifier for the newvp VP class. You can obtain a VP-class identifier with the mi_vpinfo_classid() or mi_class_id() function.

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

Return values

A char pointer
A pointer to the name of the VP class associated with the specified VP-class identifier.
NULL
The function was not successful.