msiCollectionSpider ( msParam_t *  collection,
msParam_t *  objects,
msParam_t *  action,
msParam_t *  status,
ruleExecInfo_t *  rei 
)
Description:
Applies a microservice sequence to all data objects in a collection, recursively.
Module:
ERA
Since:
2.1
Author:
Antoine de Torcy
Date:
2009-05-09
Note:
This microservice crawls an iRODS collection recursively, and executes a sequence of microservices/actions for each data object. The data object can be passed as a DataObjInp_MS_T to this microservice sequence, through 'objects'.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] collection - A CollInp_MS_T or a STR_MS_T with the iRODS path
[in] objects - Added for clarity. Only the label is required here.
[in] action - A STR_MS_T (for now) with the microservice sequence. Would need a new type.
[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 748 of file collInfoMS.c.

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