X-Git-Url: http://cloudbase.mooo.com/gitweb/z180-stamp.git/blobdiff_plain/068e826f2c2e6265e7c527082db0b5b2802dc6c6..5366852335044c1e68a5c32548d3051cc943552f:/fatfs/doc/en/read.html
diff --git a/fatfs/doc/en/read.html b/fatfs/doc/en/read.html
new file mode 100644
index 0000000..de593f0
--- /dev/null
+++ b/fatfs/doc/en/read.html
@@ -0,0 +1,74 @@
+
+
+
+FatFs - f_read
+
+
+
+
+
+
f_read
+
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 */
+);
+
+
+
Parameters
+
+fp
+Pointer to the open file object.
+buff
+Pointer to the buffer to store read data.
+btr
+Number of bytes to read in range of UINT type.
+br
+Pointer to the UINT variable to return number of bytes read. The value is always valid after the function call regardless of the result.
+
+
+
Description
+
The file read/write pointer of the file object advances number of bytes read. After the function succeeded, *br should be checked to detect end of the file. In case of *br is less than btr , it means the read/write pointer reached end of the file during read operation.
+
+
QuickInfo
+
Always available.
+