X-Git-Url: http://cloudbase.mooo.com/gitweb/z180-stamp.git/blobdiff_plain/70702af1370e44e32fb2c3c507e4759a187b4fe5..289f6a146c0b2087607d8d8659531ea90142779a:/fatfs/documents/doc/read.html?ds=sidebyside diff --git a/fatfs/documents/doc/read.html b/fatfs/documents/doc/read.html new file mode 100644 index 0000000..3f0d23b --- /dev/null +++ b/fatfs/documents/doc/read.html @@ -0,0 +1,74 @@ + + +
+ + + + + +The f_read function reads data from a file.
++FRESULT f_read ( + FIL* fp, /* [IN] File object */ + void* buff, /* [OUT] Buffer to store read data */ + UINT btr, /* [IN] Number of bytes to read */ + UINT* br /* [OUT] Number of bytes read */ +); ++
+FR_OK, +FR_DISK_ERR, +FR_INT_ERR, +FR_DENIED, +FR_INVALID_OBJECT, +FR_TIMEOUT +
+The function starts to read data from the file at the position pointed by the read/write pointer. The read/write pointer advances as number of bytes read. After the function succeeded, *br should be checked to detect end of the file. In case of *br < btr, it means the read/write pointer reached end of the file during read operation.
+Always available.
+