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_stack_limit() functionThe mi_stack_limit() function checks if the specified amount of space is available on the user stack.

The mi_stack_limit() function

The mi_stack_limit() function checks if the specified amount of space is available on the user stack.

Syntax

mi_smallint mi_stack_limit(mi_integer size);

size: The stack size, in bytes.


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

Usage

The mi_stack_limit() function checks if the space available on the user stack is greater than size plus the stack margin. The user stack checked belongs to the current thread executing on the CPU VP.

Return values

0: There is sufficient amount of available space on the user stack.
-1: The size value exceeds available space on the user stack.