msiTarFileCreate ( msParam_t *  inpParam1,
msParam_t *  inpParam2,
msParam_t *  inpParam3,
msParam_t *  inpParam4,
ruleExecInfo_t *  rei 
)
Description:
Creates a tar object file from a target collection
Module:
core
Since:
2.3
Author:
Jean-Yves Nief
Date:
2009-06-15
Note:
This microservice calls rsStructFileBundle to create a tar file (inpParam1) from a target collection (inpParam2). The content of the target collection is stored on the physical resource (inpParam3).
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inpParam1 - A StructFileExtAndRegInp_MS_T or a STR_MS_T which would be taken as dataObj path.
[in] inpParam2 - A STR_MS_T which specifies the target collection.
[in] inpParam3 - optional - A STR_MS_T which specifies the target resource.
[out] inpParam4 - optional - A STR_MS_T which specifies if the force flag is set. Set it to "force" if the force option is needed, otherwise no force option will be used.
[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 upon success
Precondition:
N/A
Postcondition:
N/A
See also:
N/A

Definition at line 3753 of file reDataObjOpr.c.

Generated on Tue Nov 12 23:09:21 2013 for iRODS Documentation by  doxygen 1.6.3