]> cloudbase.mooo.com Git - z180-stamp.git/blobdiff - fatfs/doc/en/read.html
Import fatfs R0.12b
[z180-stamp.git] / fatfs / doc / en / read.html
index de593f0e141a5ede99f127376f186bcf343874d4..80811c96da3feff45495009397d2ac6bac4442d1 100644 (file)
@@ -34,7 +34,7 @@ FRESULT f_read (
 <dt>btr</dt>\r
 <dd>Number of bytes to read in range of <tt>UINT</tt> type.</dd>\r
 <dt>br</dt>\r
-<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes read. The value is always valid after the function call regardless of the result.</dd>\r
+<dd>Pointer to the <tt>UINT</tt> variable to return number of bytes read. The value is always valid after the function call regardless of the result code.</dd>\r
 </dl>\r
 </div>\r
 \r
@@ -45,7 +45,6 @@ FRESULT f_read (
 <a href="rc.html#ok">FR_OK</a>,\r
 <a href="rc.html#de">FR_DISK_ERR</a>,\r
 <a href="rc.html#ie">FR_INT_ERR</a>,\r
-<a href="rc.html#nr">FR_NOT_READY</a>,\r
 <a href="rc.html#io">FR_INVALID_OBJECT</a>,\r
 <a href="rc.html#tm">FR_TIMEOUT</a>\r
 </p>\r
@@ -54,7 +53,7 @@ FRESULT f_read (
 \r
 <div class="para desc">\r
 <h4>Description</h4>\r
-<p>The file read/write pointer of the file object advances 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> is less than <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 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
 </div>\r
 \r
 \r