FatFs - f_gets

## f_gets

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

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

#### 引数

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

#### 戻り値

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

#### 解説

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

#### 対応情報

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

#### 参照

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

戻る