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 PR_GetError.

Description

PR_RmDir removes the directory specified by the pathname name. The directory must be empty. If the directory is not empty, PR_RmDir fails and PR_GetError returns the error code PR_DIRECTORY_NOT_EMPTY_ERROR.

See Also

PR_MkDir

Document Tags and Contributors

 Contributors to this page: teoli, alecananian
 Last updated by: teoli,