savelij13/FatFS
1
1 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fatfs v0.08b Jan 15,2011:

Browse Source 
- 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:
savelij13 committed 2025-09-11 09:45:45 +03:00
1 parent 625f3adcbb
commit 5fa1073a5a
98 files changed
+2819 -2235
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

doc/en/write.html
+18 -24
View File
@@ -11,20 +11,20 @@
<body>
<div class="para">
<div class="para func">
<h2>f_write</h2>
<p>The f_write writes data to a file.</p>
<pre>
FRESULT f_write (
FIL* <em>FileObject</em>, <span>/* Pointer to the file object structure */</span>
const void* <em>Buffer</em>, <span>/* Pointer to the data to be written */</span>
UINT <em>ByteToWrite</em>, <span>/* Number of bytes to write */</span>
UINT* <em>ByteWritten</em> <span>/* Pointer to the variable to return number of bytes written */</span>
FIL* <em>FileObject</em>, <span class="c">/* Pointer to the file object structure */</span>
const void* <em>Buffer</em>, <span class="c">/* Pointer to the data to be written */</span>
UINT <em>ByteToWrite</em>, <span class="c">/* Number of bytes to write */</span>
UINT* <em>ByteWritten</em> <span class="c">/* Pointer to the variable to return number of bytes written */</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_write (
</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-write 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 read/write pointer in the file object is increased in number of bytes written. After the function succeeded, <tt>*ByteWritten</tt> should be checked to detect the disk full. In case of <tt>*ByteWritten &lt; ByteToWrite</tt>, it means the volume got full during the write operation. The function can take a time when the volume is full or close to full.</p>
</div>
<div class="para">
<div class="para comp">
<h4>QuickInfo</h4>
<p>Available when <tt>_FS_READONLY == 0</tt>.</p>
</div>
<div class="para">
<div class="para ref">
<h4>See Also</h4>
<p><tt><a href="open.html">f_open</a>, <a href="read.html">f_read</a>, <a href="putc.html">fputc</a>, <a href="puts.html">fputs</a>, <a href="printf.html">fprintf</a>, <a href="close.html">f_close</a>, <a href="sfile.html">FIL</a></tt></p>
</div>