The mi_vpinfo_isnoyield() function

The mi_vpinfo_isnoyield() function determines whether the virtual processor (VP) on which the current UDR is executing is part of a nonyielding user-defined VP class.

Syntax

mi_integer mi_vpinfo_isnoyield(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_isnoyield() function determines whether the VP class associated with the current VP has been defined as a nonyielding user-defined VP class. The current VP is the VP on which the current UDR is running. A nonyielding user-defined VP class executes the UDR to completion, without allowing execution to yield control of the VP.

For information about the VP environment or about when to use a nonyielding user-defined VP, see the HCL OneDB™ DataBlade API Programmer's Guide.

Return values

0 (MI_FALSE)
The current VP is not part of a nonyielding VP class. The current VP class A yielding VP class.
1 (MI_TRUE)
The current VP is part of a nonyielding VP class.
MI_ERROR
The function was not successful.