Import fatfs R0.15

[z180-stamp.git] / fatfs / documents / doc / read.html

diff --git a/fatfs/documents/doc/read.html b/fatfs/documents/doc/read.html
index 3f0d23bf95114e1b7d7a4eb8d02a8f8f9af8a312..9dff6237e3fdea64cc02957a5328b9728d58e9ef 100644 (file)
--- a/fatfs/documents/doc/read.html
+++ b/fatfs/documents/doc/read.html
@@ -30,11 +30,11 @@ FRESULT f_read (
 <dt>fp</dt>\r
 <dd>Pointer to the open file object.</dd>\r
 <dt>buff</dt>\r
-<dd>Pointer to the buffer to store read data.</dd>\r
+<dd>Pointer to the buffer to store the read data.</dd>\r
 <dt>btr</dt>\r
-<dd>Number of bytes to read in range of <tt>UINT</tt> type.</dd>\r
+<dd>Number of bytes to read in range of <tt>UINT</tt> type. If the file needs to be read fast, it should be read in large chunk as possible.</dd>\r
 <dt>br</dt>\r
-<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes read. This value is always valid after the function call regardless of the function return code.</dd>\r
+<dd>Pointer to the <tt>UINT</tt> variable that receives number of bytes read. This value is always valid after the function call regardless of the function return code. If the return value is equal to <tt class="arg">btr</tt>, the function return code should be <tt>FR_OK</tt>.</dd>\r
 </dl>\r
 </div>\r
 \r
@@ -54,7 +54,7 @@ FRESULT f_read (
 \r
 <div class="para desc">\r
 <h4>Description</h4>\r
-<p>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, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> &lt; <tt class="arg">btr</tt>, it means the read/write pointer reached end of the file during read operation.</p>\r
+<p>The function starts to read data from the file at the file offset pointed by read/write pointer. The read/write pointer advances as number of bytes read. After the function succeeded, <tt class="arg">*br</tt> should be checked to detect end of the file. In case of <tt class="arg">*br</tt> &lt; <tt class="arg">btr</tt>, it means the read/write pointer hit end of the file during read operation.</p>\r
 </div>\r
 \r
 \r
@@ -64,6 +64,12 @@ FRESULT f_read (
 </div>\r
 \r
 \r
+<div class="para use">\r
+<h4>Example</h4>\r
+<p>Refer to the example in <tt>f_open</tt>.</p>\r
+</div>\r
+\r
+\r
 <div class="para ref">\r
 <h4>See Also</h4>\r
 <p><tt><a href="open.html">f_open</a>, <a href="gets.html">fgets</a>, <a href="write.html">f_write</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>\r