streamWrapper::stream_seek
(PHP 4 >= 4.3.2, PHP 5, PHP 7, PHP 8)
streamWrapper::stream_seek — Seeks to specific location in a stream
Description
$offset
, int $whence
= SEEK_SET): boolThis method is called in response to fseek().
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 tooffset
bytes.SEEK_CUR
- Set position to current location plusoffset
.SEEK_END
- Set position to end-of-file plusoffset
.
Note: The current implementation never sets
whence
toSEEK_CUR
; instead such seeks are internally converted toSEEK_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.