streamWrapper::stream_seek
(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)
Seeks to specific location in a stream
Description
This method is called in response to fseek().
The read/write position of the stream should be updated according to the offset and whence.
Parameters
offsetThe stream offset to seek to.
whencePossible values:
SEEK_SET- Set position equal tooffsetbytes.SEEK_CUR- Set position to current location plusoffset.SEEK_END- Set position to end-of-file plusoffset.
NoteThe current implementation never sets
whencetoSEEK_CUR; instead such seeks are internally converted toSEEK_SETseeks.
Return Values
Return true if the position was updated, false otherwise.
Notes
If not implemented, false is assumed as the return value.
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.
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.