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_isnoyield() functionThe 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.

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.