debian man page for dpm_getstatus_getreq

DPM_GETSTATUS_GETREQ(3) 				       DPM Library Functions					   DPM_GETSTATUS_GETREQ(3)

NAME
       dpm_getstatus_getreq - get status for a dpm_get request

SYNOPSIS
       #include <sys/types.h>
       #include "dpm_api.h"

       int dpm_getstatus_getreq (char *r_token, int nbfromsurls, char **fromsurls, int *nbreplies, struct dpm_getfilestatus **filestatuses)

DESCRIPTION
       dpm_getstatus_getreq gets status for a dpm_get request.

       The input arguments are:

       r_token
	      specifies the token returned by a previous get request.

       nbfromsurls
	      specifies the number of files for which the status is requested. If zero, the status of all files in the get request is returned.

       fromsurls
	      specifies the array of file names.

       The output arguments are:

       nbreplies
	      will be set to the number of replies in the array of file statuses.

       filestatuses
	      will  be	set to the address of an array of dpm_getfilestatus structures allocated by the API. The client application is responsible
	      for freeing the array when not needed anymore.

       struct dpm_getfilestatus {
	    char      *from_surl;
	    char      *turl;
	    u_signed64	   filesize;
	    int       status;
	    char      *errstring;
	    time_t    pintime;
       };

RETURN VALUE
       This routine returns 0 if the operation was successful or -1 if the operation failed. In the latter case, serrno is set appropriately.

ERRORS
       EFAULT	    nbfromsurls is strictly positive and fromsurls is NULL or r_token, nbreplies or filestatuses is a NULL pointer.

       ENOMEM	    Memory could not be allocated for marshalling the request.

       EINVAL	    nbfromsurls is not positive, the token is invalid/unknown or all file requests have errors.

       SENOSHOST    Host unknown.

       SEINTERNAL   Database error.

       SECOMERR     Communication error.

LCG
							   $Date: 2006/03/23 06:12:41 $ 				   DPM_GETSTATUS_GETREQ(3)