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_interrupt_check() functionThe mi_interrupt_check() function checks for a user interrupt.

The mi_interrupt_check() function

The mi_interrupt_check() function checks for a user interrupt.

Syntax

mi_integer mi_interrupt_check()


Valid in client LIBMI application?	Valid in user-defined routine?
No	Yes

Usage

The mi_interrupt_check() function determines whether the client application has interrupted the current operation by sending a break signal to the database server. When mi_interrupt_check() returns a nonzero value, the C UDR returns an appropriate error.

Return values

0: The client application did not interrupt the current operation.
<> 0: The client application interrupted the current operation.