The mi_stream_tell() function
The mi_stream_tell() function returns the current seek position of an open stream, relative to the beginning of the stream.
Syntax
mi_int8 *mi_stream_tell(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_tell() function obtains the current seek position of the stream that strm_desc references. The stream seek position is the offset for the next read or write operation on the stream. The mi_stream_tell() function returns this seek position as a pointer to an mi_int8 value.
Return values
- An mi_int8 pointer
- A pointer to the stream seek position, measured in the number of bytes from the beginning of the stream.
- NULL
- The function was not successful.