1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
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=
"up" title=
"FatFs" href=
"../00index_e.html">
7 <link rel=
"alternate" hreflang=
"ja" title=
"Japanese" href=
"../ja/unlink.html">
8 <link rel=
"stylesheet" href=
"../css_e.css" type=
"text/css" media=
"screen" title=
"ELM Default">
9 <title>FatFs - f_unlink
</title>
14 <div class=
"para func">
16 <p>The f_unlink function removes a file or sub-directory from the volume.
</p>
19 const TCHAR*
<span class=
"arg">path
</span> <span class=
"c">/* [IN] Object name */
</span>
24 <div class=
"para arg">
28 <dd>Pointer to a null-terminated string that specifies the
<a href=
"filename.html">file or sub-directory
</a> to be removed.
</dd>
33 <div class=
"para ret">
34 <h4>Return Values
</h4>
36 <a href=
"rc.html#ok">FR_OK
</a>,
37 <a href=
"rc.html#de">FR_DISK_ERR
</a>,
38 <a href=
"rc.html#ie">FR_INT_ERR
</a>,
39 <a href=
"rc.html#nr">FR_NOT_READY
</a>,
40 <a href=
"rc.html#ok">FR_NO_FILE
</a>,
41 <a href=
"rc.html#np">FR_NO_PATH
</a>,
42 <a href=
"rc.html#in">FR_INVALID_NAME
</a>,
43 <a href=
"rc.html#dn">FR_DENIED
</a>,
44 <a href=
"rc.html#wp">FR_WRITE_PROTECTED
</a>,
45 <a href=
"rc.html#id">FR_INVALID_DRIVE
</a>,
46 <a href=
"rc.html#ne">FR_NOT_ENABLED
</a>,
47 <a href=
"rc.html#ns">FR_NO_FILESYSTEM
</a>,
48 <a href=
"rc.html#tm">FR_TIMEOUT
</a>,
49 <a href=
"rc.html#lo">FR_LOCKED
</a>,
50 <a href=
"rc.html#nc">FR_NOT_ENOUGH_CORE
</a>
55 <div class=
"para desc">
58 If condition of the object to be removed is applicable to the following terms, the function will be rejected.
<ul>
59 <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>
60 <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>
61 <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>
66 <div class=
"para comp">
68 <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>
72 <p class=
"foot"><a href=
"../00index_e.html">Return
</a></p>