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_is_copy() functionThe mi_error_desc_is_copy() function determines whether the specified error descriptor is a user copy.

The mi_error_desc_is_copy() function

The mi_error_desc_is_copy() function determines whether the specified error descriptor is a user copy.

Syntax

mi_integer mi_error_desc_is_copy(err_desc)
   MI_ERROR_DESC *err_desc;

err_desc

A pointer to the error descriptor to examine.


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

Usage

The mi_error_desc_is_copy() function determines whether the err_desc error descriptor is a user copy. A user copy of an error descriptor is one that the mi_error_desc_copy() function has allocated. The mi_error_desc_destroy() function returns an error if you attempt to deallocate a system-allocated error descriptor. Use this function to determine when to perform deallocation of an error descriptor with the mi_error_desc_destroy() function.

An invalid error descriptor can cause the mi_error_desc_is_copy() function to fail.

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

Return values

MI_TRUE: The error descriptor that err_desc references is a user copy.
MI_FALSE: The error descriptor that err_desc references is not a user copy.
MI_ERROR: The function was not successful.