SplFileObject::fseek
(PHP 5 >= 5.1.0)
SplFileObject::fseek — ファイルポインタを移動させる
説明
public int SplFileObject::fseek
( int
$offset
[, int $whence = SEEK_SET
] )
offset を whence で指定される位置に追加することで、ファイルの始めからバイト単位でファイルポイントを移動させます。
パラメータ
-
offset -
オフセットです。負の値はポインタを戻すために使うことができます。これは SEEK_END が
whenceの値として使われるときに便利です。 -
whence -
whenceの値は次のようなものになります:SEEK_SET-offsetバイトに等しい位置にセットします。SEEK_CUR- 現在の位置にoffsetを加えた位置にセットします。SEEK_END- 終端にoffsetを加えた位置にセットします。
whenceが指定されない場合、SEEK_SETが前提になります。
返り値
探索が成功した場合は 0、そうでなければ -1 が返されます。終端より先の位置を探索してもエラーにならないことにご注意してください。
例
例1 SplFileObject::fseek() の例
<?php
$file = new SplFileInfo("somefile.txt");
// 最初の行を読み込む
$data = $file->fgets();
// ファイルの最初に戻る
// $file->rewind(); と同じ
$file->fseek(0);
?>