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