The mi_stream_get_error() function
The mi_stream_get_error() function returns the last error status for an open stream and clears the error condition.
Syntax
mi_integer mi_stream_get_error(strm_desc)
MI_STREAM *strm_desc;
- strm_desc
- A pointer to a stream descriptor for an open stream.
Valid in client LIBMI application? | Valid in user-defined routine? |
---|---|
No | Yes |
Usage
The mi_stream_get_error() function obtains the last error status of the stream that strm_desc references and then clears the error condition.
Return values
- A valid stream error code
- The last error that occurred on the stream.
For information about stream error codes, see the HCL OneDB™ DataBlade® API Programmer's Guide.
- MI_STREAM_EBADARG
- The stream descriptor that strm_desc references is invalid.