fatfs v0.08b Jan 15,2011:
- Fast seek feature is also applied to f_read() and f_write(). - f_lseek() reports required table size on creating CLMP. - Extended format syntax of f_printf function. - Ignores duplicated directory separators in given path names.
This commit is contained in:
1 parent
625f3adcbb
commit
5fa1073a5a
98 files changed
+2819
-2235
No files matched your search
+18
-24
@@ -11,20 +11,20 @@
|
||||
|
||||
<body>
|
||||
|
||||
<div class="para">
|
||||
<div class="para func">
|
||||
<h2>f_read</h2>
|
||||
<p>The f_read function reads data from a file.</p>
|
||||
<pre>
|
||||
FRESULT f_read (
|
||||
FIL* <em>FileObject</em>, <span>/* Pointer to the file object structure */</span>
|
||||
void* <em>Buffer</em>, <span>/* Pointer to the buffer to store read data */</span>
|
||||
UINT <em>ByteToRead</em>, <span>/* Number of bytes to read */</span>
|
||||
UINT* <em>ByteRead</em> <span>/* Pointer to the variable to return number of bytes read */</span>
|
||||
FIL* <em>FileObject</em>, <span class="c">/* Pointer to the file object structure */</span>
|
||||
void* <em>Buffer</em>, <span class="c">/* Pointer to the buffer to store read data */</span>
|
||||
UINT <em>ByteToRead</em>, <span class="c">/* Number of bytes to read */</span>
|
||||
UINT* <em>ByteRead</em> <span class="c">/* Pointer to the variable to return number of bytes read */</span>
|
||||
);
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="para">
|
||||
<div class="para arg">
|
||||
<h4>Parameters</h4>
|
||||
<dl class="par">
|
||||
<dt>FileObject</dt>
|
||||
@@ -39,38 +39,32 @@ FRESULT f_read (
|
||||
</div>
|
||||
|
||||
|
||||
<div class="para">
|
||||
<div class="para ret">
|
||||
<h4>Return Values</h4>
|
||||
<dl class="ret">
|
||||
<dt>FR_OK (0)</dt>
|
||||
<dd>The function succeeded.</dd>
|
||||
<dt>FR_DENIED</dt>
|
||||
<dd>The function denied due to the file has been opened in non-read mode.</dd>
|
||||
<dt>FR_DISK_ERR</dt>
|
||||
<dd>The function failed due to an error in the disk function.</dd>
|
||||
<dt>FR_INT_ERR</dt>
|
||||
<dd>The function failed due to a wrong FAT structure or an internal error.</dd>
|
||||
<dt>FR_NOT_READY</dt>
|
||||
<dd>The disk drive cannot work due to no medium in the drive or any other reason.</dd>
|
||||
<dt>FR_INVALID_OBJECT</dt>
|
||||
<dd>The file object is invalid.</dd>
|
||||
</dl>
|
||||
<p>
|
||||
<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>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="para">
|
||||
<div class="para desc">
|
||||
<h4>Description</h4>
|
||||
<p>The file pointer of the file object increases in number of bytes read. After the function succeeded, <tt>*ByteRead</tt> should be checked to detect the end of file. In case of <tt>*ByteRead < ByteToRead</tt>, it means the read/write pointer reached end of the file during read operation.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="para">
|
||||
<div class="para comp">
|
||||
<h4>QuickInfo</h4>
|
||||
<p>Always available.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="para">
|
||||
<div class="para ref">
|
||||
<h4>See Also</h4>
|
||||
<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>
|
||||
</div>
|
||||
|
||||
Reference in new issue
Block a user