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_file_allocate() functionThe mi_file_allocate() function ensures that a specified number of files are available to be opened.

The mi_file_allocate() function

The mi_file_allocate() function ensures that a specified number of files are available to be opened.

Syntax

mi_integer mi_file_allocate(num_files)
   mi_integer num_files

num_files: specifies how many file descriptors to allocate.


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

Usage

The mi_file_allocate() function allocates num_files number of file descriptors for use with operating-system calls, such as UNIX™ open() or fopen().

Tip: The mi_file_allocate() function is provided for compatibility with earlier versions only. This function is not required for file access in DataBlade® API modules. In new code, use DataBlade API file-access functions such as mi_file_open() and mi_file_close().

Server only: This function does not perform any tasks when called within a UDR.

Return values

>=0: The number of file descriptors that mi_file_allocate() has allocated.
MI_ERROR: The function was not successful.

The mi_file_allocate() function does not throw an MI_Exception event when it encounters a runtime error. It does not cause callbacks to start.