The mi_error_desc_finish() function
The mi_error_desc_finish() function completes processing of the current exception list.
Syntax
mi_integer mi_error_desc_finish(err_desc)
MI_ERROR_DESC *err_desc;- err_desc
- A pointer to the current error descriptor in the list of current exceptions.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| No | Yes |
Usage
The mi_error_desc_finish() function discards any further messages in the exception list of which err_desc is part. The exception list contains the error descriptors for situations that generate multiple exceptions. Normally, an exception callback is called once for each exception. However, if a situation generates multiple exceptions, you probably do not want the callback to be invoked for each exception. This function prevents the current callback function from being invoked for any more exceptions in the current exception list.
Return values
- 0
- The function was successful.
- MI_ERROR
- The function was not successful.