An error descriptor

The DataBlade® API stores information about exceptions and errors in an error descriptor. An error descriptor is an MI_ERROR_DESC structure. It holds information for the MI_Exception and MI_Client_Library_Error event types.

The following table summarizes the memory operations for an error descriptor.
Memory duration Memory operation Function name
Current® memory duration Constructor mi_error_desc_copy()
Current memory duration Destructor mi_error_desc_destroy()

When an MI_Exception or MI_Client_Library_Error event occurs, the DataBlade API invokes the appropriate callback. To this callback, the DataBlade API passes an initialized error descriptor as the third callback argument. The error descriptor contains information about the MI_Exception or MI_Client_Library_Error event. Within the callback, use the accessor functions in Accessor functions for an error descriptor to obtain the error information from the error descriptor.