.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "GFS_RMDIR" "3" "13 November 2006" "Gfarm" ""

.SH NAME
gfs_rmdir \- delete a directory
.SH SYNOPSIS
.sp
\fB#include <gfarm/gfarm.h>
.sp
char *gfs_rmdir (char * \fIgfarm_url\fB);
\fR
.SH "DESCRIPTION"
.PP
\fBgfs_rmdir()\fR deletes a directory whose name
is the string specified by \fIgfarm_url\fR\&.  The
directory must be empty.
.SH "RETURN VALUES"
.TP
\fBNULL\fR
The function terminated successfully.
.TP
\fBGFARM_ERR_NO_MEMORY\fR
Insufficient memory was available.
.TP
\fBGFARM_ERR_PERMISSION_DENIED\fR
\fIgfarm_url\fR
points outside your accessible address space.
.TP
\fBGFARM_ERR_DIRECTORY_NOT_EMPTY\fR
Directory is not empty.
.TP
\fBGFARM_ERR_NO_SUCH_OBJECT\fR
Directory does not exist.
.TP
\fBGFARM_ERR_NOT_A_DIRECTORY\fR
A component of the path prefix is not a directory.
.TP
\fBOthers\fR
An error except the above occurred.  The reason is shown by its
pointed strings.