bionic (3) lfc_readdirg.3.gz

NAME

       lfc_readdirg - read LFC directory opened by lfc_opendir in the name server

SYNOPSIS

       #include <sys/types.h>
       #include "lfc_api.h"

       struct lfc_direnstatg *lfc_readdirg (lfc_DIR *dirp)

DESCRIPTION

       lfc_readdirg  reads  the  LFC directory opened by lfc_opendir in the name server.  This routine returns a
       pointer to a structure containing the current directory entry including the GUID associated.

       struct lfc_direnstatg {
            u_signed64     fileid;
            char      guid[CA_MAXGUIDLEN+1];
            mode_t         filemode;
            int       nlink;         /* number of files in a directory */
            uid_t          uid;
            gid_t          gid;
            u_signed64     filesize;
            time_t         atime;         /* last access to file */
            time_t         mtime;         /* last file modification */
            time_t         ctime;         /* last metadata modification */
            short          fileclass;     /* not used */
            char      status;        /* ' ' --> online, 'm' --> migrated */
            char      csumtype[3];   /* "CS", "AD" or "MD" */
            char      csumvalue[33];
            unsigned short d_reclen; /* length of this entry */
            char      d_name[1];     /* basename in variable length */
       };

       lfc_readdirg caches a variable number of such entries, depending on the filename size,  to  minimize  the
       number of requests to the name server.

       dirp   specifies the pointer value returned by lfc_opendir.

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,  serrno  is  set
       appropriately.

       As lfc_readdirg returns a null pointer both at the end of the directory  and  on  error,  an  application
       wishing  to  check for error situations should set serrno to 0, then call lfc_readdirg, then check serrno
       and if it is non-zero, assume an error has occurred.

ERRORS

       EBADF        File descriptor in DIR structure is invalid.

       EFAULT       dirp is a NULL pointer.

       SECOMERR     Communication error.

       ENSNACT      Name server is not running or is being shutdown.

SEE ALSO

       lfc_closedir(3), lfc_opendirg(3), lfc_rewinddir(3)

AUTHOR

       LCG Grid Deployment Team