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_unlink() functionThe mi_file_unlink() function unlinks (removes) a file that mi_file_open() previously opened.

The mi_file_unlink() function

The mi_file_unlink() function unlinks (removes) a file that mi_file_open() previously opened.

Syntax

mi_integer mi_file_unlink(fd)
   mi_integer fd;

fd: The file descriptor of the file to remove. The file descriptor is obtained by a previous call to mi_file_open().


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

Usage

The mi_file_unlink() function removes the operating-system file that fd identifies. This function is a destructor function for an operating-system file descriptor.

Client only: A call to mi_file_unlink() from a client LIBMI application raises an exception.

Server only: This function can only unlink a file that is on the server computer.

Return values

MI_OK: The function was successful.
MI_ERROR: The function was not successful.

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