streamWrapper::stream_seek

Seeks to specific location in a stream

&reftitle.description; public `bool` `streamWrapper::stream_seek` `int` `offset` `int` `whence` SEEK_SET

This method is called in response to `fseek`.

The read/write position of the stream should be updated according to the `offset` and `whence`.

&reftitle.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`.
&reftitle.returnvalues;

Return &true; if the position was updated, &false; otherwise.

&reftitle.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.

&reftitle.seealso;

- `fseek`