lfc_readdirxp man page

LFC_READDIRXP(3)             LFC Library Functions            LFC_READDIRXP(3)

[1mNAME[0m
      lfc_readdirxp  -  read  LFC directory opened by [1mlfc_opendir [22min the name
      server

[1mSYNOPSIS[0m
      [1m#include <sys/types.h>[0m
      [1m#include "lfc_api.h"[0m

      [1mstruct lfc_direnrep *lfc_readdirxp (lfc_DIR *[4m[22mdirp[24m[1m, char *[4m[22mpattern[24m[1m,  char[0m
      [1m*[4m[22mse[24m[1m)[0m

[1mDESCRIPTION[0m
      [1mlfc_readdirxp [22mreads the LFC directory opened by [1mlfc_opendir [22min the name
      server.  It does restricted pattern matching on basename.  This routine
      returns a pointer to a structure containing the current directory entry
      (basename, guid and filesize) and the replica information.

      struct lfc_rep_info {
           u_signed64     fileid;
           char      status;
           char      *host;
           char      *sfn;
      };

      struct lfc_direnrep {
           u_signed64     fileid;
           char      guid[CA_MAXGUIDLEN+1];
           mode_t         filemode;
           u_signed64     filesize;
           int       nbreplicas;
           struct lfc_rep_info *rep;     /* array of replica info structures */
           unsigned short d_reclen; /* length of this entry */
           char      d_name[1];     /* basename in variable length */
      };

      [1mlfc_readdirxp [22mcaches a variable number of such  entries,  depending  on
      the  filename  size,  to  minimize  the  number of requests to the name
      server.

      [4mdirp[24m   specifies the pointer value returned by [1mlfc_opendir[22m.

      [4mpattern[0m
             allows to restrict the listing to entries  having  the  basename
             starting with this pattern.

      [4mse[24m     allows to restrict the replica entries to a given SE.

[1mRETURN VALUE[0m
      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, [1mserrno [22mis set appropriately.

      As  lfc_readdirxp  returns a null pointer both at the end of the direc-
      tory and on error, an application wishing to check for error situations
      should  set [1mserrno [22mto 0, then call lfc_readdirxp, then check [1mserrno [22mand
      if it is non-zero, assume an error has occurred.

[1mERRORS[0m
      [1mEBADF        [22mFile descriptor in DIR structure is invalid.

      [1mENOMEM       [22mMemory could not be allocated for unmarshalling the reply.

      [1mEFAULT       [4m[22mdirp[24m is a NULL pointer.

      [1mEINVAL       [22mThe length of [4mpattern[24m exceeds [1mCA_MAXNAMELEN [22mor the  length
                   of [4mse[24m exceeds [1mCA_MAXHOSTNAMELEN[22m.

      [1mSECOMERR     [22mCommunication error.

      [1mENSNACT      [22mName server is not running or is being shutdown.

[1mSEE ALSO[0m
      [1mlfc_closedir(3)[22m, [1mlfc_opendirg(3)[22m, [1mlfc_rewinddir(3)[0m

[1mAUTHOR[0m
      [1mLCG Grid Deployment [22mTeam

LFC          $Date: 2011-06-15 09:20:59 +0200 (Wed, 15 Jun 2011L)FC$_READDIRXP(3)