stream_get_line

(PHP 5, PHP 7)

stream_get_line指定されたデリミタの位置までのデータを一行分としてストリームから読み込む

説明

stream_get_line ( resource $handle , int $length [, string $ending ] ) : string

指定したハンドルから一行取得します。

読み込みは、length バイト読まれたか、 ending で指定された文字列がストリームに見つかった か (この文字列は返値に 含まれません)、あるいは EOF に達したとき、のうち一番最初に遭遇したところで停止します。

この関数は fgets() とほとんど同一ですが、 \n や \r 、\r\n といった一般的な文字列以外を行末を示すデリミタ として指定できる点で、またデリミタ自体を返値に 含まない 点で異なります。

パラメータ

handle

有効なファイルハンドル。

length

ハンドルから読み込むバイト数。

ending

オプションのデリミタ文字列。

返り値

最大 length バイトの、 handle で指定されたリソースから読み込んだデータを返します。

エラーが発生した際には、FALSE を返します。

参考

  • fread() - バイナリセーフなファイルの読み込み
  • fgets() - ファイルポインタから 1 行取得する
  • fgetc() - ファイルポインタから1文字取り出す