dpm_getreqsummary man page

DPM_GETREQSUMMARY(3)         DPM Library Functions        DPM_GETREQSUMMARY(3)

[1mNAME[0m
      dpm_getreqsummary - get summary for a set of requests

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

      [1mint  dpm_getreqsummary  (int [4m[22mnbtokens[24m[1m, char **[4m[22mr_tokens[24m[1m, int *[4m[22mnbreplies[24m[1m,[0m
      [1mstruct dpm_reqsummary **[4m[22msummaries[24m[1m)[0m

[1mDESCRIPTION[0m
      [1mdpm_getreqsummary [22mgets summary for a set of requests.

      The input arguments are:

      [4mnbtokens[0m
             specifies the number of tokens in the request.

      [4mr_tokens[0m
             specifies an array of tokens returned by  previous  get/put/copy
             requests.

      The output arguments are:

      [4mnbreplies[0m
             will  be  set  to  the number of replies in the array of request
             summaries.

      [4msummaries[0m
             will be set to the address of an array of dpm_reqsummary  struc-
             tures  allocated by the API. The client application is responsi-
             ble for freeing the array when not needed anymore.

      struct dpm_reqsummary {
           char      r_token[CA_MAXDPMTOKENLEN+1];
           char      r_type;
           int       nb_reqfiles;
           int       nb_queued;
           int       nb_finished;
           int       nb_progress;
      };

[1mRETURN VALUE[0m
      This routine returns 0 if the operation was successful  or  -1  if  the
      operation failed. In the latter case, [1mserrno [22mis set appropriately.

[1mERRORS[0m
      [1mEFAULT       [4m[22mr_tokens[24m [4m,[24m [4mnbreplies[24m or [4msummaries[24m is a NULL pointer.

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

      [1mEINVAL       [4m[22mnbtokens[24m  is not strictly positive or the specified tokens
                   are invalid/unknown.

      [1mSENOSHOST    [22mHost unknown.

      [1mSEINTERNAL   [22mDatabase error.

      [1mSECOMERR     [22mCommunication error.

LCG                      $Date: 2004/12/15 08:04:58 $     DPM_GETREQSUMMARY(3)