1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4<meta http-equiv="Content-Type" content="text/html; charset=windows-1252" />
5<meta http-equiv="Content-Style-Type" content="text/css" />
6<title>FS_DeleteDirectory</title>
7<link rel="stylesheet" href="../../css/nitro.css" type="text/css" />
8</head>
9<body>
10<h1>FS_DeleteDirectory <img src="../../image/NTR.gif"align="middle"><img src="../../image/TWL.gif" align="middle"></h1>
11<h2>Syntax</h2>
12
13<pre><code>
14#include &lt;nitro/fs.h&gt;
15
16BOOL FS_DeleteDirectory(const char *path);
17</code></pre>
18<h2>Arguments</h2>
19<table style="width:100%">
20<tbody>
21<tr>
22<td style="width:13%"><CODE>path</CODE></td>
23<td style="width:87%">Path name of the directory to delete.</td>
24</tr>
25</tbody>
26</table>
27
28<h2>Return Values</h2>
29<p>Returns TRUE if the directory was deleted properly; returns FALSE otherwise. In case of failure, the error details can be obtained using <code><a href="../archive/FS_GetArchiveResultCode.html">FS_GetArchiveResultCode()</a></code>.</p>
30
31<h2>Description</h2>
32<p>Deletes the specified directory. The function returns FALSE in the following situations:
33</p>
34<ul>
35<li>If the target archive does not support the deletion of directories</li>
36<li>If the specified directory does not exist</li>
37<li>If the specified directory is not empty</li>
38</ul>
39
40<h2>Note</h2>
41<ul>
42<li>This function cannot be called from the interrupt handler (IRQ mode). Also note that in some cases processing may not end if interrupts are left prohibited.</li>
43</ul>
44
45<h2>See Also</h2>
46<p><code><a href="../FS_PERMIT.html">FS_PERMIT_*</a> <br /> <a href="FS_CreateDirectory.html">FS_CreateDirectory</A><br /> <a href="FS_RenameDirectory.html">FS_RenameDirectory</A><br /> <a href="../file/FS_GetResultCode.html">FS_GetResultCode</A></code></p>
47
48<h2>Revision History</h2>
49<p>
502009/02/05 Added empty-directory error.<br /> 2007/09/18 Initial version.<br />
51</p>
52<hr><p>CONFIDENTIAL</p></body>
53</html>
54