blob: 7aa4aeb8c72c77a0fcbe02a054cc3706a13763a2 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
PR_RmDir
========
Removes a directory with a specified name.
Syntax
------
.. code::
#include <prio.h>
PRStatus PR_RmDir(const char *name);
Parameter
~~~~~~~~~
The function has the following parameter:
``name``
The name of the directory to be removed.
Returns
~~~~~~~
- If successful, ``PR_SUCCESS``.
- If unsuccessful, ``PR_FAILURE``. The actual reason can be retrieved
via :ref:`PR_GetError`.
Description
-----------
:ref:`PR_RmDir` removes the directory specified by the pathname ``name``.
The directory must be empty. If the directory is not empty, :ref:`PR_RmDir`
fails and :ref:`PR_GetError` returns the error code
``PR_DIRECTORY_NOT_EMPTY_ERROR``.
See Also
--------
:ref:`PR_MkDir`
|
