The mi_error_desc_copy() function

The mi_error_desc_copy() function returns a copy of a specified error descriptor.

Syntax

MI_ERROR_DESC *mi_error_desc_copy(src_err_desc)
   MI_ERROR_DESC *src_err_desc;
src_err_desc
A pointer to the error descriptor to copy.
Valid in client LIBMI application? Valid in user-defined routine?
Yes Yes

Usage

The mi_error_desc_copy() function is the constructor function for the error descriptor. It creates a copy of the src_err_desc error descriptor.

Server only: The mi_error_desc_copy() function allocates a new error descriptor in the current memory duration.
Important: Be sure to destroy the MI_ERROR_DESC structure with the mi_error_desc_destroy() function when your DataBlade® API code no longer needs it.

For a general discussion of how to copy error descriptors, see the Informix® DataBlade® API Programmer's Guide.

Return values

An MI_ERROR_DESC pointer
A pointer to the newly allocated copy of the error descriptor that src_err_desc references.
NULL
The function was not successful.