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_error_desc_destroy() functionThe mi_error_desc_destroy() function frees an error descriptor that the mi_error_desc_copy() function allocated.

The mi_error_desc_destroy() function

The mi_error_desc_destroy() function frees an error descriptor that the mi_error_desc_copy() function allocated.

Syntax

mi_integer mi_error_desc_destroy(err_desc)
   MI_ERROR_DESC *err_desc;

err_desc

A pointer to the error descriptor to free.


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

Usage

The mi_error_desc_destroy() function is a destructor function for the error descriptor. It frees the error descriptor that err_desc references. The mi_error_desc_copy() function must previously have allocated the err_desc error descriptor. This function can fail if either of the following error conditions exists:

The err_desc structure is not a valid MI_ERROR_DESC structure.
The err_desc structure is internally managed (it was not created by the mi_error_desc_copy() function) and therefore cannot be freed by the user.

Use the mi_error_desc_is_copy() function to determine how the err_desc structure was allocated.

For a general discussion of how to release a copy of an error descriptor, see the HCL OneDB™ DataBlade® API Programmer's Guide.

Return values

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