1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> 2<html lang="en"> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 5<meta http-equiv="Content-Style-Type" content="text/css"> 6<link rel="stylesheet" href="../css_e.css" type="text/css" media="screen" title="ELM Default"> 7<title>FatFs - f_unlink</title> 8</head> 9 10<body> 11 12<div class="para func"> 13<h2>f_unlink</h2> 14<p>The f_unlink function removes a file or sub-directory from the volume.</p> 15<pre> 16FRESULT f_unlink ( 17 const TCHAR* <span class="arg">path</span> <span class="c">/* [IN] Object name */</span> 18); 19</pre> 20</div> 21 22<div class="para arg"> 23<h4>Parameter</h4> 24<dl class="par"> 25<dt>path</dt> 26<dd>Pointer to a null-terminated string that specifies the <a href="filename.html">file or sub-directory</a> to be removed. If a null pointer is given, the function fails with <tt>FR_INVALID_DRIVE</tt>.</dd> 27</dl> 28</div> 29 30 31<div class="para ret"> 32<h4>Return Values</h4> 33<p> 34<a href="rc.html#ok">FR_OK</a>, 35<a href="rc.html#de">FR_DISK_ERR</a>, 36<a href="rc.html#ie">FR_INT_ERR</a>, 37<a href="rc.html#nr">FR_NOT_READY</a>, 38<a href="rc.html#ok">FR_NO_FILE</a>, 39<a href="rc.html#np">FR_NO_PATH</a>, 40<a href="rc.html#in">FR_INVALID_NAME</a>, 41<a href="rc.html#dn">FR_DENIED</a>, 42<a href="rc.html#wp">FR_WRITE_PROTECTED</a>, 43<a href="rc.html#id">FR_INVALID_DRIVE</a>, 44<a href="rc.html#ne">FR_NOT_ENABLED</a>, 45<a href="rc.html#ns">FR_NO_FILESYSTEM</a>, 46<a href="rc.html#tm">FR_TIMEOUT</a>, 47<a href="rc.html#lo">FR_LOCKED</a>, 48<a href="rc.html#nc">FR_NOT_ENOUGH_CORE</a> 49</p> 50</div> 51 52 53<div class="para desc"> 54<h4>Description</h4> 55<p> 56If condition of the object to be removed is applicable to the following terms, the function will be rejected.<ul> 57<li>The file/sub-directory must not have read-only attribute (<tt>AM_RDO</tt>), or the function will be rejected with <tt>FR_DENIED</tt>.</li> 58<li>The sub-directory must be empty and must not be current directory, or the function will be rejected with <tt>FR_DENIED</tt>.</li> 59<li>The file/sub-directory must not be opened, or the <em>FAT volume can be collapsed</em>. It will be rejected safely when <a href="appnote.html#dup">file lock function</a> is enabled.</li> 60</ul> 61</div> 62 63 64<div class="para comp"> 65<h4>QuickInfo</h4> 66<p>Available when <tt><a href="config.html#fs_readonly">FF_FS_READONLY</a> == 0</tt> and <tt><a href="config.html#fs_minimize">FF_FS_MINIMIZE</a> == 0</tt>.</p> 67</div> 68 69 70<p class="foot"><a href="../00index_e.html">Return</a></p> 71</body> 72</html> 73