f_gets

ファイルから文字列を読み出します。

TCHAR* f_gets (
  TCHAR* buff, /* [OUT] バッファ */
  int len,     /* [IN] バッファのサイズ */
  FIL* fp      /* [IN] ファイル オブジェクト */
);

引数

buff
文字列を読み出すバッファを指すポインタを指定します。
len
バッファのサイズを要素数で指定します。
fp
ファイル オブジェクト構造体へのポインタを指定します。

戻り値

関数が成功するとbuffが返されます。

解説

この関数はf_read()のラッパー関数です。読み出し動作は、最初の'\n'を読み込むか、ファイル終端に達するか、len - 1文字を読み出すまで続きます。読み込まれた文字列の終端には'\0'が付加されます。既にファイル終端で1文字も読み込まれなかったとき、または何らかのエラーが発生したときは関数は失敗しヌル ポインタを返します。ファイル終端かエラーかはf_eof(),f_error()マクロで調べられます。

Unicode API構成(_LFN_UNICODE == 1)が選択されているときは、buffはUTF-16文字列になりますが、ファイル上のエンコードは、_STRF_ENCODEオプションで選択できます。それ以外の時は無変換(1バイト/1文字)で読み出します。

対応情報

_USE_STRFUNCが1または2のとき使用可能です。2のときは、ファイルに含まれる'\r'が取り除かれてバッファに読み込まれます。

参照

f_open, f_read, f_putc, f_puts, f_printf, f_close, FIL

戻る