msiDataObjCopy ( msParam_t *  inpParam1,
msParam_t *  inpParam2,
msParam_t *  msKeyValStr,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)

This microservice copies a file from one logical (source) collection to another logical (destination) collection that is physically located in the input resource

Module:
core
Since:
pre-2.1
Author:
Michael Wan
Date:
2007-02-12
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inpParam1 - a DataObjCopyInp_MS_T or DataObjInp_MS_T which is the source DataObjInp or STR_MS_T which would be the source object path.
[in] inpParam2 - Optional - a DataObjInp_MS_T which is the destination DataObjInp or STR_MS_T which would be the destination object path.
[in] msKeyValStr - Optional - a STR_MS_T. This is the special msKeyValStr format of keyWd1=value1++++keyWd2=value2++++keyWd3=value3... If the keyWd is not specified (without the '=' char), the value is assumed to be the target resource ("destRescName") for backward compatibility. Valid keyWds are:

  • "destRescName" - the resource to copy to.
  • "forceFlag" - overwrite existing copy. This keyWd has no value. But the '=' character is still needed
  • "numThreads" - the number of threads to use.
  • "filePath" - The physical file path of the uploaded file on the server.
  • "dataType" - the data type of the file.
  • "verifyChksum" - verify the transfer using checksum. this keyWd has no value. But the '=' character is still needed.
[out] outParam - a INT_MS_T for the status.
[in,out] rei - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.
Session Variables Used:
none
Session Variables Modified:
none
iCAT Attributes Used:
none
iCAT Attributes Modified:
none
Side Effect:
none
Returns:
integer
Return values:
0 on success
Precondition:
none
Postcondition:
none
See also:
none

Definition at line 1033 of file reDataObjOpr.c.

Generated on Tue Nov 12 23:18:34 2013 for iRODS Documentation by  doxygen 1.6.3