streamWrapper::stream_seek
(PHP 4 >= 4.3.2, PHP 5)
streamWrapper::stream_seek — Seeks to specific location in a stream
Description
$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.
Parameters
-
offset -
The stream offset to seek to.
-
whence -
Possible values:
SEEK_SET- Set position equal tooffsetbytes.SEEK_CUR- Set position to current location plusoffset.SEEK_END- Set position to end-of-file plusoffset.
Return Values
Return TRUE if the position was updated, FALSE otherwise.
Notes
Note:
If not implemented,
FALSEis 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.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Другие базовые расширения
- Потоки
- Функция streamWrapper::__construct() - Создает новый объект-обертку для потока
- Функция streamWrapper::__destruct() - Уничтожает существующую обертку потока
- Функция streamWrapper::dir_closedir() - Обработчик закрытия директории
- Функция streamWrapper::dir_opendir() - Обработчик открытия директории
- Функция streamWrapper::dir_readdir() - Обработчик чтения содержимого директории
- Функция streamWrapper::dir_rewinddir() - Обработчик перемещения на начало директории
- Функция streamWrapper::mkdir() - Создание директории
- Функция streamWrapper::rename() - Переименовывает файл или директорию
- Функция streamWrapper::rmdir() - Удаляет директорию
- Функция streamWrapper::stream_cast() - Получает ресурс уровнем ниже
- Функция streamWrapper::stream_close() - Закрывает ресурс
- Функция streamWrapper::stream_eof() - Проверяет достижение конца файла по файловому указателю
- Функция streamWrapper::stream_flush() - Сохранение данных вывода
- Функция streamWrapper::stream_lock() - Advisory file locking
- Функция streamWrapper::stream_metadata() - Изменяет настройки потока
- Функция streamWrapper::stream_open() - Открывает файл или URL
- Функция streamWrapper::stream_read() - Читает из потока
- Функция streamWrapper::stream_seek() - Перемещение на заданную позицию в потоке
- Функция streamWrapper::stream_set_option() - Изменение настроек потока
- Функция streamWrapper::stream_stat() - Получение информации о файловом ресурсе
- Функция streamWrapper::stream_tell() - Определение текущей позиции потока
- Функция streamWrapper::stream_truncate() - Усечение потока
- Функция streamWrapper::stream_write() - Запись в поток
- Функция streamWrapper::unlink() - Удаление файла
- Функция streamWrapper::url_stat() - Получение информации о файле
Коментарии
Please notice that the return value of this function is a boolean but the return value of fseek is 0 for ok and -1 for failure.
Please use this implementation when working with files:
function stream_seek($offset, $whence) {
if(0 === fseek($this->_handler, $offset, $whence)){
return true;
}
return false;
}