.\" @(#)$RCSfile: lfc_readdir.man,v $ $Revision: 4458 $ $Date: 2011-06-15 09:20:59 +0200 (Wed, 15 Jun 2011) $ CERN IT-PDP/DM Jean-Philippe Baud
.\" Copyright (C) 1999-2011 by CERN/IT/PDP/DM
.\" All rights reserved
.\"
.TH LFC_READDIR 3 "$Date: 2011-06-15 09:20:59 +0200 (Wed, 15 Jun 2011) $" LFC "LFC Library Functions"
.SH NAME
lfc_readdir \- read LFC directory opened by
.B lfc_opendir
in the name server
.SH SYNOPSIS
.B #include <sys/types.h>
.br
.B #include <dirent.h>
.br
\fB#include "lfc_api.h"\fR
.sp
.BI "struct dirent *lfc_readdir (lfc_DIR *" dirp )
.SH DESCRIPTION
.B lfc_readdir
reads the LFC directory opened by
.B lfc_opendir
in the name server.
This routine returns a pointer to a structure containing the current directory
entry.
.B lfc_readdir
caches a variable number of such entries, depending on the filename size, to
minimize the number of requests to the name server.
.TP
.I dirp
specifies the pointer value returned by
.BR lfc_opendir .
.SH NOTE
Only the fields d_name, d_reclen and on some platforms d_namlen are filled.
.SH RETURN VALUE
This routine returns a pointer to a structure containing the current directory
entry if the operation was successful or NULL if the end of the directory was
reached or if the operation failed. When the end of the directory is encountered,
serrno is not changed. If the operation failed,
.B serrno
is set appropriately.

As lfc_readdir returns a null pointer
both at the end of the directory and on error, an application wishing to check
for error situations should set
.B serrno
to 0, then call lfc_readdir, then check
.B serrno
and if it is non-zero, assume an error has occurred.
.SH ERRORS
.TP 1.3i
.B EBADF
File descriptor in DIR structure is invalid.
.TP
.B EFAULT
.I dirp
is a NULL pointer.
.TP
.B SECOMERR
Communication error.
.TP
.B ENSNACT
Name server is not running or is being shutdown.
.SH SEE ALSO
.BR lfc_closedir(3) ,
.BR lfc_opendirg(3) ,
.BR lfc_rewinddir(3) ,
.B dirent
.SH AUTHOR
\fBLCG Grid Deployment\fP Team