【PHP8.x】ftell関数の使い方
作成日: 更新日:
ftell関数は、指定されたファイルポインタの現在位置を取得する関数です。ファイルポインタとは、ファイル内で次にデータを読み書きする位置を示す目印です。この関数を使うと、ファイルの先頭(0バイト目)から数えて現在位置が何バイト目にあるかを整数値で取得できます。
引数には、fopen()
関数などで開かれたファイルのリソースを渡します。成功すると、ファイルの先頭からのバイトオフセットが返されます。ファイルポインタの取得に失敗した場合や、無効なリソースが指定された場合は、false
が返されます。
この関数は、fseek()
関数と組み合わせて使われることが多く、fseek()
でファイルポインタを移動させた後、その位置が正しく設定されたかを確認したり、ファイル処理途中の位置を記憶して後で再開したりする際に役立ちます。正確なファイル操作のため、ftell関数の戻り値を確認し、適切なエラー処理を行うことが推奨されます。
基本的な使い方
構文(syntax)
ftell(resource $stream): int|false
引数(parameters)
resource $stream
- resource $stream: ファイルポインタ(ストリーム)を指定するリソース型
戻り値(return)
int|false
ファイルポインタの現在の位置をバイト数で返します。ファイルポインタが移動できない場合は false を返します。