sousa-gecko/docs/nspr/reference/pr_rmdir.md

PR_RmDir

Removes a directory with a specified name.

Syntax

#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