streamWrapper::stream_seek
ストリーム内の特定の場所に移動する
説明
public bool streamWrapper::stream_seek(int $offset
, int $whence
= SEEK_SET)
ストリームの読み込み/書き込み位置を、
offset
と whence
に応じて更新しなければなりません。
パラメータ
-
offset
-
移動するストリームオフセット。
-
whence
-
使用可能な値
SEEK_SET
- offset
バイト目の位置に移動する。
SEEK_CUR
- 現在位置から offset
バイトぶん進める。
SEEK_END
- ファイルの終端から offset
バイトぶん進める。
注意:
現在の実装は、
whence
の値を SEEK_CUR
に設定することはありません。
そのようなシークは、
内部的に SEEK_SET
と同じ動きに変換されます。
戻り値
位置を更新した場合に true
、それ以外の場合に false
を返します。
注意
注意:
実装されていないの戻り値は false
とみなされます。
注意:
成功した場合、
streamWrapper::stream_seek をコールした直後に
streamWrapper::stream_tell がコールされます。
streamWrapper::stream_tell が失敗すると、
呼び出し元関数への戻り値は false
に設定されます。
注意:
ストリーム上でシーク操作をしたときに、必ずこの関数がコールされるとは限りません。
PHP のストリームはバッファ付きの読み込みがデフォルトで有効になっている
(stream_set_read_buffer も参照ください)
ので、シーク操作が単なるバッファポインタの移動だけで済む場合があります。