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