The mi_streamread_integer() function
The mi_streamread_integer() function reads an mi_integer (INTEGER) value from a stream, converting any difference in the stream representation to that of the internal representation.
Syntax
mi_integer mi_streamread_integer(strm_desc, int_ptr)
MI_STREAM *strm_desc;
mi_integer *int_ptr;- strm_desc
- A pointer to the stream descriptor for the open stream from which to read the mi_integer value.
- int_ptr
- A pointer to the buffer into which to copy the mi_integer value.
| Valid in client LIBMI application? | Valid in user-defined routine? |
|---|---|
| No | Yes |
Usage
The mi_streamread_integer() function reads an mi_integer value from the stream that strm_desc references. The function reads this value into the mi_integer buffer that int_ptr references. The read operation begins at the current stream seek position. You can use mi_stream_tell() or mi_stream_getpos() to obtain this seek position.
The mi_streamread_integer() function is useful in a streamread() support function of an opaque data type that contains an mi_integer value.
For more information about the use of mi_streamread_integer() in a streamread() support function, see the HCL OneDB™ DataBlade® API Programmer's Guide.
Return values
- >=0
- The number of bytes that the function has read from the open stream to the value that int_ptr references.
- MI_STREAM_EEOF
- The end of the stream has been reached without any errors.
- MI_STREAM_EBADARG
- The stream descriptor that strm_desc references or the value that int_ptr references is invalid.
- MI_ERROR
- The function was not successful.