|
msiGetCollectionSize |
( |
msParam_t * |
collPath, |
|
|
msParam_t * |
outKVPairs, |
|
|
msParam_t * |
status, |
|
|
ruleExecInfo_t * |
rei | |
|
) |
| | |
- Description:
- Returns the object count and total disk usage of a collection
- Module:
- ERA
- Since:
- pre-2.1
- Author:
- Antoine de Torcy
- Date:
- 2008-10-31
- Note:
- This microservice returns the object count and total disk usage for all objects in a collection, recursively. The results are written to a KeyValPair_MS_T whose keyword strings are "Size" and "Object Count".
- Example Usage:
- See clients/icommands/test/rules3.0/
- Parameters:
-
[in] | collPath | - A CollInp_MS_T or a STR_MS_T with the irods path of the target collection. |
[out] | outKVPairs | - A KeyValPair_MS_T containing the results. |
[out] | status | - 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:
-
- Precondition:
- None
- Postcondition:
- None
- See also:
- None
Definition at line 486 of file collInfoMS.c.
|