Google

NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.7">

fgets

(PHP 3, PHP 4 )

fgets -- ファイルポインタから1行取得する

説明

string fgets ( int fp [, int length])

fpで指定したファイルポインタから最大length-1バイト読み出し、その 文字列を返します。読み出しは、length-1バイト読み出したか、(返り値 に含まれる)改行文字を検出したか、EOFに達したかのいずれかが起こっ た時点で終了します。lengthが指定されない場合、デフォルトは1kまた は1024バイトとなります。

エラーが起こった場合、FALSEを返します。

陥りやすい罠:

C言語のfgetsの動作に慣れている人は、EOFを返す条件の違いについて 注意する必要があります。

ファイルポインタは有効なものでなければならず、また fopen()popen()fsockopen()で正常にオープンされたファイルを 指している必要があります。

簡単な例を以下に示します。

例 1行毎にファイルを読み込む

$fd = fopen ("/tmp/inputfile.txt", "r");
while (!feof ($fd)) {
  $buffer = fgets($fd, 4096);
  echo $buffer;
}
fclose ($fd);

注意 lengthパラメータは、PHP 4.2.0でオプション となりました。

fread(), fopen(), popen(), fgetc(), fsockopen(), socket_set_timeout() も参照下さい。