f_gets

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

TCHAR* f_gets (
  TCHAR* Str,       /* バッファ */
  int Size,         /* バッファのサイズ */
  FIL* FileObject   /* ファイル・オブジェクト */
);

引数

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

戻り値

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

解説

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

APIにUnicodeが選択されている(_LFN_UNICODEが1)ときは、UTF-8エンコードのテキスト・ファイルとしてUCS-2に変換してバッファに読み込みます。それ以外の時は無変換(1文字1バイト)で読み込みます。

対応情報

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

参照

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

戻る