irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

dataObjGet.h
Go to the documentation of this file.
1 #ifndef DATA_OBJ_GET_H__
2 #define DATA_OBJ_GET_H__
3 
4 #include "rcConnect.h"
5 #include "rodsDef.h"
6 #include "dataObjInpOut.h"
7 
8 
9 /* prototype for the client call */
10 /* rcDataObjGet - Get (download) a iRODS data object.
11  * Input -
12  * rcComm_t *conn - The client connection handle.
13  * dataObjInp_t *dataObjInp - generic dataObj input. Relevant items are:
14  * objPath - the path of the data object.
15  * numThreads - Number of threads to use. NO_THREADING ==> no threading,
16  * 0 ==> server will decide (default), >0 ==> number of threads.
17  * openFlags - should be set to O_RDONLY.
18  * condInput - conditional Input
19  * FORCE_FLAG_KW - overwrite an existing data object
20  * REPL_NUM_KW - "value" = The replica number of the copy to
21  * download.
22  * VERIFY_CHKSUM_KW - verify the checksum of the download file.
23  * return value - The status of the operation.
24  */
25 
26 #ifdef __cplusplus
27 extern "C"
28 #endif
29 int rcDataObjGet( rcComm_t *conn, dataObjInp_t *dataObjInp, char *locFilePath );
30 int _rcDataObjGet( rcComm_t *conn, dataObjInp_t *dataObjInp, portalOprOut_t **portalOprOut, bytesBuf_t *dataObjOutBBuf );
31 
32 #endif
rcComm_t
Definition: rcConnect.h:95
_rcDataObjGet
int _rcDataObjGet(rcComm_t *conn, dataObjInp_t *dataObjInp, portalOprOut_t **portalOprOut, bytesBuf_t *dataObjOutBBuf)
Definition: rcDataObjGet.cpp:252
portalOprOut
Definition: dataObjInpOut.h:114
rcConnect.h
dataObjInpOut.h
rodsDef.h
rcDataObjGet
int rcDataObjGet(rcComm_t *conn, dataObjInp_t *dataObjInp, char *locFilePath)
Definition: rcDataObjGet.cpp:91
DataObjInp
Definition: dataObjInpOut.h:65
BytesBuf
Definition: rodsDef.h:197