|
msiRmColl |
( |
msParam_t * |
inpParam1, |
|
|
msParam_t * |
msKeyValStr, |
|
|
msParam_t * |
outParam, |
|
|
ruleExecInfo_t * |
rei | |
|
) |
| | |
- Description:
- This microservice calls rsRmColl to recursively remove a collection as part of a workflow execution.
- Module:
- core
- Since:
- pre-2.1
- Author:
- Michael Wan
- Date:
- 2007-04-02
- Example Usage:
- See clients/icommands/test/rules3.0/
- Parameters:
-
[in] | inpParam1 | - a CollInp_MS_T or a STR_MS_T which would be taken as dataObj path. |
[in] | msKeyValStr | - This is the special msKeyValStr format of keyWd1=value1++++keyWd2=value2++++keyWd3=value3... If the keyWd is not specified (without the '=' char), the value is assumed to be one of the keywords listed below for backwards compatibility. Valid keyWds are :
- "forceFlag" - Remove the data object instead of putting it in the trash. This keyWd has no value. But the '=' character is still needed.
- "irodsAdminRmTrash" - Admin remove trash. This keyWd has no value.
- "irodsRmTrash" - Remove trash. This keyWd has no value.
|
[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:
-
- Precondition:
- none
- Postcondition:
- none
- See also:
- none
Definition at line 2113 of file reDataObjOpr.c.
|