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/unlink.html
+32 -37
View File
@@ -11,17 +11,17 @@
<body>
<div class="para">
<div class="para func">
<h2>f_unlink</h2>
<p>The f_unlink function removes an object.</p>
<p>The f_unlink function removes a file or directory.</p>
<pre>
FRESULT f_unlink (
const TCHAR* <em>FileName</em> <span>/* Pointer to the object name */</span>
const TCHAR* <em>FileName</em> <span class="c">/* Pointer to the object name */</span>
);
</pre>
</div>
<div class="para">
<div class="para arg">
<h4>Parameter</h4>
<dl class="par">
<dt>FileName</dt>
@@ -30,47 +30,42 @@ FRESULT f_unlink (
</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_NO_FILE</dt>
<dd>Could not find the file or directory.</dd>
<dt>FR_NO_PATH</dt>
<dd>Could not find the path.</dd>
<dt>FR_INVALID_NAME</dt>
<dd>The path name is invalid.</dd>
<dt>FR_INVALID_DRIVE</dt>
<dd>The drive number is invalid.</dd>
<dt>FR_DENIED</dt>
<dd>The function was denied due to either of following reasons:
<ul><li>The object has read-only attribute</li><li>Not empty directory</li><li>Current directory</li></ul></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_WRITE_PROTECTED</dt>
<dd>The medium is write protected.</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_ENABLED</dt>
<dd>The logical drive has no work area.</dd>
<dt>FR_NO_FILESYSTEM</dt>
<dd>There is no valid FAT volume on the drive.</dd>
<dt>FR_LOCKED</dt>
<dd>The function was rejected due to file shareing policy (_FS_SHARE).</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#ok">FR_NO_FILE</a>,
<a href="rc.html#np">FR_NO_PATH</a>,
<a href="rc.html#in">FR_INVALID_NAME</a>,
<a href="rc.html#de">FR_DENIED</a>,
<a href="rc.html#ex">FR_EXIST</a>,
<a href="rc.html#wp">FR_WRITE_PROTECTED</a>,
<a href="rc.html#id">FR_INVALID_DRIVE</a>,
<a href="rc.html#ne">FR_NOT_ENABLED</a>,
<a href="rc.html#ns">FR_NO_FILESYSTEM</a>,
<a href="rc.html#tm">FR_TIMEOUT</a>,
<a href="rc.html#lo">FR_LOCKED</a>,
<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a>
</p>
</div>
<div class="para">
<div class="para desc">
<h4>Description</h4>
<p>The f_unlink function removes an object. <em>Do not remove open objects</em>.</p>
<p>
If condition of the object to be removed is applicable to the following terms, the function will fail with error.
<ul>
<li>The object must not have read-only attribute (AM_RDO) or the function will be rejected with FR_DENIED.</li>
<li>The directory must be empty and must not be current directory or the function will be rejected with FR_DENIED.</li>
<li>The file must not being opened or the <em>FAT volume can be collapted</em>. It will able to be rejected with FR_LOCKED when <a href="appnote.html#dup">file shareing control</a> is enabled.</li>
</ul>
</div>
<div class="para">
<div class="para comp">
<h4>QuickInfo</h4>
<p>Available when <tt>_FS_READONLY == 0</tt> and <tt>_FS_MINIMIZE == 0</tt>.</p>
</div>