msiPhyBundleColl ( msParam_t *  inpParam1,
msParam_t *  inpParam2,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)
Description:
Bundles a collection into a number of tar files, similar to the iphybun command
Module:
core
Since:
2.3
Author:
Jean-Yves Nief
Date:
2009-06-15
Note:
This microservice calls rsPhyBundleColl to bundle files in a collection into a number of tar files to make it more efficient to store these files on tape. This microservice has the same functionality as the iphybun command.
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 the collection for the phybun.
[in] inpParam2 - optional - a STR_MS_T which specifies the target resource. If one wants to modify the value of the maximum number of subfiles contained in the tar file (default=5120), the input should be like this: "<target resource name>++++N=10000". In this example, it will allow to merge up to 10000 files in a single tar file. Note that if this number is too high, it can cause some significant overhead for operations like retrieving a single file within a tar file (stage, untar and register in iRODS lots of files). If the syntax after "++++" is invalid, it will be ignored.
[out] outParam - An 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 upon success
Precondition:
N/A
Postcondition:
N/A
See also:
N/A

Definition at line 3871 of file reDataObjOpr.c.

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