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)  

dataObjOpen.h
Go to the documentation of this file.
1 
3 /* dataObjOpen.h
4  */
5 
6 #ifndef DATA_OBJ_OPEN_H__
7 #define DATA_OBJ_OPEN_H__
8 
9 #include "rcConnect.h"
10 #include "dataObjInpOut.h"
11 #include "objInfo.h"
12 
13 /* definition for phyOpenFlag */
14 #define DO_PHYOPEN 0
15 #define DO_NOT_PHYOPEN 1
16 #define PHYOPEN_BY_SIZE 2
17 
18 /* prototype for the client call */
19 /* rcDataObjOpen - Open a iRODS data object.
20  * Input -
21  * rcComm_t *conn - The client connection handle.
22  * dataObjInp_t *dataObjInp - generic dataObj input. Relevant items are:
23  * objPath - the path of the data object.
24  * dataType - the data type of the object (optional).
25  * openFlag - O_WRONLY, O_RDONLY , etc. The O_CREAT will create the
26  * file if it does not exist.
27  * condInput - condition input (optional).
28  * DATA_TYPE_KW - "value" = the data type of the object
29  * FORCE_FLAG_KW - overwrite an existing data object
30  * REG_CHKSUM_KW - compute the checksum value
31  * VERIFY_CHKSUM_KW - compute and verify the checksum on the data.
32  * FILE_PATH_KW - "value" = the physical path of the
33  * destination file. Vaild only if O_CREAT is on.
34  * REPL_NUM_KW - "value" = The replica number of the copy to
35  * open.
36  * DEST_RESC_NAME_KW - "value" = The destination Resource. Vaild
37  * only if O_CREAT is on.
38  *
39  * OutPut -
40  * int l1descInx - an integer descriptor.
41  */
42 
43 
44 #ifdef __cplusplus
45 extern "C"
46 #endif
47 int rcDataObjOpen( rcComm_t *conn, dataObjInp_t *dataObjInp );
48 
49 #endif
rcComm_t
Definition: rcConnect.h:95
rcConnect.h
dataObjInpOut.h
DataObjInp
Definition: dataObjInpOut.h:65
objInfo.h
rcDataObjOpen
int rcDataObjOpen(rcComm_t *conn, dataObjInp_t *dataObjInp)
Definition: rcDataObjOpen.cpp:67