msiDataObjGet ( msParam_t *  inpParam1,
msParam_t *  msKeyValStr,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)
Description:
This microservice requests the client to call a rcDataObjGet API as part of a workflow execution.
Module:
core
Since:
pre-2.1
Author:
Michael Wan
Date:
2007-02-12
Note:
This call should only be used through the rcExecMyRule (irule) call i.e., rule execution initiated by clients and should not be called internally by the server since it interacts with the client through the normal client/server socket connection. Also, it should never be called through delayExec since it requires client interaction.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inpParam1 - A DataObjInp_MS_T or STR_MS_T which would be taken as dataObj 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 client's local file path ("localPath") for backward compatibility.. Valid keyWds are:

  • "localPath" - the client's local file path.
  • "rescName" - the resource of the copy to get.
  • "replNum" - the replica number of the copy to get.
  • "numThreads" - the number of threads to use.
  • "forceFlag" - overwrite local copy. This keyWd has no value. But the '=' character is still needed
  • "verifyChksum" - verify the transfer using checksum. this keyWd has no value. But the '=' character is still needed.
[out] outParam - a INT_MS_T containing 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 1330 of file reDataObjOpr.c.

Generated on Mon Jun 25 14:00:57 2012 for iRODS Documentation by  doxygen 1.6.3