# gfs_rmdir

## Name

gfs_rmdir -- delete a directory

## Synopsis

    #include <gfarm/gfarm.h>

```char *gfs_rmdir``(char * `gfarm_url`);`

## DESCRIPTION

`gfs_rmdir()` deletes a directory whose name is the string specified by `gfarm_url`. The directory must be empty.

## RETURN VALUES

`NULL`

  The function terminated successfully.

`GFARM_ERR_NO_MEMORY`

  Insufficient memory was available.

`GFARM_ERR_PERMISSION_DENIED`

  `gfarm_url` points outside your accessible address space.

`GFARM_ERR_DIRECTORY_NOT_EMPTY`

  Directory is not empty.

`GFARM_ERR_NO_SUCH_OBJECT`

  Directory does not exist.

`GFARM_ERR_NOT_A_DIRECTORY`

  A component of the path prefix is not a directory.

Others

  An error except the above occurred. The reason is shown by its pointed strings.