streamWrapper::stream_seek
Seeks to specific location in a stream
Description
public bool streamWrapper::stream_seek(int $offset, int $whence = SEEK_SET)
The read/write position of the stream should be updated according to the
offset and whence.
Parameters
-
offset
-
The stream offset to seek to.
-
whence
-
Possible values:
SEEK_SET - Set position equal to offset bytes.SEEK_CUR - Set position to current location plus offset.SEEK_END - Set position to end-of-file plus offset.
Note:
The current implementation never sets whence to
SEEK_CUR; instead such seeks are internally converted
to SEEK_SET seeks.
Return Values
Return true if the position was updated, false otherwise.
Notes
Note:
If not implemented, false is assumed as the return value.
Note:
Upon success,
streamWrapper::stream_tell is called directly after
calling streamWrapper::stream_seek. If
streamWrapper::stream_tell fails, the return
value to the caller function will be set to false.
Note:
Not all seeks operations on the stream will result in this function being
called. PHP streams have read buffering enabled by default (see also
stream_set_read_buffer) and seeking may be done by
merely moving the buffer pointer.