mi_integer mi_stream_seek(strm_desc, offset, whence)
   MI_STREAM *strm_desc;
   mi_int8 *offset;
   mi_integer whence;

strm_desc

is a pointer to a stream descriptor for an open stream.

offset

is a pointer to a positive or negative byte offset from the whence seek position.

whence

is a constant that specifies the position from which to start the seek operation to the offset position.

Valid in Client LIBMI Application?	Valid in User-Defined Routine?
No	Yes

The mi_stream_seek( ) function uses the whence and offset arguments to determine the new seek position of the stream that strm_desc references, as follows:

• The whence argument identifies the position from which to start the seek operation.

  Valid values include the following whence constants.

  Whence Constant

  Starting Position for Seek Operation

  MI_LO_SEEK_SET

  The start of the stream

  MI_LO_SEEK_CUR

  The current seek position of the stream

  MI_LO_SEEK_END

  The end of the stream

  • The offset argument identifies the offset, in bytes, from the starting position (which the whence argument specifies) at which to begin the seek operation.

    This offset value can be negative for all values of whence. For more information on how to access eight-bit (INT8) integers, see the IBM Informix: DataBlade API Programmer's Guide.

Use the associated stream-open function to obtain the stream descriptor for one of these data streams. You can then pass this stream descriptor to mi_stream_seek( ) to set the seek position on any of these streams. You can also implement an mi_stream_seek( ) function for your own user-defined stream. For more information, see the IBM Informix: DataBlade API Programmer's Guide.

On success, mi_stream_seek( ) returns MI_OK. To obtain the new stream seek position, use mi_stream_tell( ).

MI_OK

indicates that the new stream seek position has been set to the combination of whence and offset.

MI_STREAM_EBADARG

indicates that the stream descriptor that strm_desc references or the offset value is invalid, or that the specified seek position is past the end of the data.

MI_STREAM_ENIMPL

indicates that the stream class does not implement the seek position.

MI_ERROR

indicates that the function was not successful.

MI_STREAM_EWHENCE

indicates that the whence value is invalid.

See also the descriptions of mi_stream_open_fio( ), mi_stream_open_mi_lvarchar( ), mi_stream_open_str( ), mi_stream_read( ), mi_stream_setpos( ), mi_stream_tell( ), and mi_stream_write( ).