msiGetCollectionContentsReport ( msParam_t *  inpParam1,
msParam_t *  inpParam2,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)
Description:
Returns the number of objects in a collection by data type
Module:
ERA
Since:
pre-2.1
Author:
Antoine de Torcy
Date:
2008-03-17
Note:
This microservice returns the number of objects for each known data type in a collection, recursively. The results are written to a KeyValPair_MS_T, with a keyword for each data type plus "unknown" for objects of unknown data type, and the number of data objects of that type.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inpParam1 - A CollInp_MS_T or a STR_MS_T with the irods path of the target collection.
[out] inpParam2 (poorly named...) - A KeyValPair_MS_T containing the results.
[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 on success
Precondition:
None
Postcondition:
None
See also:
None

Definition at line 322 of file collInfoMS.c.

Generated on Fri Mar 15 13:40:30 2013 for iRODS Documentation by  doxygen 1.6.3