streamWrapper::stream_seek

(PHP 4 >= 4.3.2, PHP 5, PHP 7)

streamWrapper::stream_seek — Перемещение на заданную позицию в потоке

Описание

public streamWrapper::stream_seek ( int $offset , int $whence = SEEK_SET ) : bool

Этот метод вызывается в процессе выполнения fseek().

Позицию чтения/записи в потоке необходимо обновлять в соответствии с аргументами offset и whence.

Список параметров

offset

Смещение в потоке, на которое требуется переместиться.

whence

Возможные значения:

  • SEEK_SET - Переместиться на позицию offset байт от начала файла.
  • SEEK_CUR - Переместиться на offset байт относительно текущей позиции.
  • SEEK_END - Переместиться на позицию offset байт от конца файла.

Возвращаемые значения

Возвращает TRUE, если позиция обновлена, FALSE в остальных случаях.

Примечания

Замечание:

Если не реализован, в качестве возвращаемого значения принимается FALSE.

Замечание:

В случае успеха streamWrapper::stream_tell() будет вызвана сразу после того, как streamWrapper::stream_seek() отработает. Если выполнение streamWrapper::stream_tell() завершится неудачей, то в вызывающую функцию будет возвращено значение FALSE

Замечание:

Не все операции перемещения в потоке приведут к вызову этой функции. В PHP по умолчанию включена буферизация потоков (см. также stream_set_read_buffer()), поэтому перемещение в потоке может означать лишь перемещение указателя в буфере.

Смотрите также

  • fseek() - Устанавливает смещение в файловом указателе