summaryrefslogtreecommitdiff
path: root/fatfs/doc/en/read.html
diff options
context:
space:
mode:
authorLeo C2016-09-08 19:15:27 +0200
committerLeo C2016-09-08 19:15:27 +0200
commit70702af1370e44e32fb2c3c507e4759a187b4fe5 (patch)
tree5b75a408efadf5fccd8d5d481e91cce73a86897b /fatfs/doc/en/read.html
parent7b78a5a287827db9e9b16286f3604aef69b37c5c (diff)
downloadz180-stamp-70702af1370e44e32fb2c3c507e4759a187b4fe5.zip
Import fatfs R0.12bfatfs-0.12b
Diffstat (limited to 'fatfs/doc/en/read.html')
-rw-r--r--fatfs/doc/en/read.html5
1 files changed, 2 insertions, 3 deletions
diff --git a/fatfs/doc/en/read.html b/fatfs/doc/en/read.html
index de593f0..80811c9 100644
--- a/fatfs/doc/en/read.html
+++ b/fatfs/doc/en/read.html
@@ -34,7 +34,7 @@ FRESULT f_read (
<dt>btr</dt>
<dd>Number of bytes to read in range of <tt>UINT</tt> type.</dd>
<dt>br</dt>
-<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>
+<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>
</dl>
</div>
@@ -45,7 +45,6 @@ FRESULT f_read (
<a href="rc.html#ok">FR_OK</a>,
<a href="rc.html#de">FR_DISK_ERR</a>,
<a href="rc.html#ie">FR_INT_ERR</a>,
-<a href="rc.html#nr">FR_NOT_READY</a>,
<a href="rc.html#io">FR_INVALID_OBJECT</a>,
<a href="rc.html#tm">FR_TIMEOUT</a>
</p>
@@ -54,7 +53,7 @@ FRESULT f_read (
<div class="para desc">
<h4>Description</h4>
-<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>
+<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>
</div>