f_read

ファイルからデータを読み出します。

FRESULT f_read (
  FIL* FileObject,    // ファイルオブジェクト構造体
  void* Buffer,       // 読み出したデータを格納するバッファ
  WORD ByteToRead,    // 読み出すバイト数
  WORD* ByteRead      // 読み出されたバイト数
);

パラメータ

FileObject
ファイルオブジェクト構造体へのポインタを指定します。
Buffer
読み出したデータを格納するバッファを指すポインタを指定します。
ByteToRead
読み出すバイト数を指定します。
ByteRead
実際に読み出されたバイト数を格納する変数を指すポインタを指定します。

戻り値

FR_OK (0)
正常終了。
FR_DENIED
書き込み専用モードで開いたファイルから読み込もうとした。
FR_RW_ERROR
ディスクアクセスでエラーが発生した。
FR_NOT_READY
メディアがセットされていないなど、ディスクドライブが動作不能状態。
FR_NOT_ENABLED
FatFsモジュールが停止状態。

解説

読み込み開始位置は、現在のファイルR/Wポインタからになります。ファイルR/Wポインタは読み込まれたバイト数だけ進みます。読み込み中にファイルの終端に達すると、*ByteReadはByteToReadよりも小さくなります。

参照

f_open, f_write, f_close, FIL

戻る