msiStructFileBundle ( msParam_t *  collection,
msParam_t *  bundleObj,
msParam_t *  resource,
msParam_t *  status,
ruleExecInfo_t *  rei 
)
Description:
Bundles a collection for export
Module:
ERA
Since:
2.1
Author:
Antoine de Torcy
Date:
2009-04-21
Note:
This microservice creates a bundle for export from an iRODS collection on a target resource. Files in the collection are first replicated onto the target resource. If no resource is given the default resource will be used.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] collection - A CollInp_MS_T or a STR_MS_T with the irods path of the collection to bundle.
[in] bundleObj - a DataObjInp_MS_T or a STR_MS_T with the bundle object's path.
[in] resource - Optional - a STR_MS_T which specifies the target resource.
[out] status - an INT_MS_T containing the operation 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 633 of file collInfoMS.c.

Generated on Wed Jun 5 23:10:53 2013 for iRODS Documentation by  doxygen 1.6.3