fscanf - フォーマットに基づきファイルからの入力を処理する

説明

mixed fscanf ( resource $handle , string $format [, mixed &$... ] )

関数fscanf() は sscanf() に似ていますが、handle が指すファイルから入力を取得し、指定したフォーマット format に基づき解釈を行います。フォーマットについては sprintf() に解説されています。

フォーマット文字列におけるあらゆる空白は入力ストリームのあらゆる空白にマッチします。これはつまりフォーマット文字列の\t（タブ）すらも入力ストリームの空白1個にマッチしてしまうことを意味します。

fscanf() をコールするたびに、ファイルから 1 行ずつ読み込みます。

パラメータ

handle: fopen() を使用して作成したファイルシステムポインタリソース。
format: sprintf() のドキュメントに説明されているフォーマット。
...: オプションで代入する値。

返り値

この関数のパラメータが二つだけの場合、処理された値は配列として返されます。他方、オプションのパラメータが指定された場合、この関数は、代入された値の数を返します。オプション引数は参照渡しとする必要があります。

変更履歴

バージョン説明

4.3.0 このバージョンまでは、ファイルから読み込む文字の最大数は512 （または最初に\nが現れるまで）でした。これ以降では任意の長い行を読みスキャンすることができます。

例

例1 fscanf() の例


<?php
$handle = fopen("users.txt", "r");
while ($userinfo = fscanf($handle, "%s\t%s\t%s\n")) {
    list ($name, $profession, $countrycode) = $userinfo;
    //... これらの値を使用して何か行う
}
fclose($handle);
?>

例2 users.txt の内容

javier  argonaut        pe
hiroshi sculptor        jp
robert  slacker us
luigi   florist it

参考

fread() - バイナリセーフなファイルの読み込み
fgets() - ファイルポインタから 1 行取得する
fgetss() - ファイルポインタから 1 行取り出し、HTML タグを取り除く
sscanf() - フォーマット文字列に基づき入力を処理する
printf() - フォーマット済みの文字列を出力する
sprintf() - フォーマットされた文字列を返す