.\" 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_OPENDIR" "3" "29 October 2003" "Gfarm" ""
.SH NAME
gfs_opendir \- open a directory
.SH SYNOPSIS
.sp
\fB#include <gfarm/gfarm.h>
.sp
char *gfs_opendir (const char * \fIgfarm_url\fB, GFS_Dir * \fIdirp\fB);
\fR
.SH "DESCRIPTION"
.PP
The \fBgfs_opendir()\fR function opens a directory stream
corresponding to the directory \fIgfarm_url\fR, and returns the
directory stream to the address pointed by \fIdirp\fR.  The stream is
positioned at the first entry in the directory.
.SH "RETURN VALUES"
.TP
\fBNULL\fR
The function terminated successfully.
.TP
\fBGFARM_ERR_NO_MEMORY\fR
Insufficient memory was available.
.TP
\fBGFARM_ERR_AUTHENTICATION\fR
User authentication failed when connecting to gfmd(8).
.TP
\fBGFARM_ERR_PERMISSION_DENIED\fR
\fIgfarm_url\fR
points outside your accessible address space.
.TP
\fBGFARM_ERR_NO_SUCH_OBJECT\fR
Directory does not exist.
.TP
\fBOthers\fR
An error except the above occurred.  The reason is shown by its
pointed strings.
.SH "SEE ALSO"
.PP
\fBgfs_closedir\fR(3),
\fBgfs_readdir\fR(3)