Informix DataBlade API Programmer's Manual DataBlade API Function Descriptions

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

mi_integer mi_error_desc_destroy(err_desc)

MI_ERROR_DESC *err_desc;

err_desc

is a pointer to the error descriptor to free.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
Yes	Yes

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 mi_error_desc_copy()) 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.

See the descriptions of the following functions: mi_errmsg(), mi_error_desc_copy(), mi_error_desc_is_copy(), mi_error_level(), mi_error_sql_state(), and mi_error_sqlcode().

For a general discussion of how to copy error descriptors, see Creating a Copy of an Error Descriptor.