|
msiDataObjUnlink |
( |
msParam_t * |
inpParam, |
|
|
msParam_t * |
outParam, |
|
|
ruleExecInfo_t * |
rei | |
|
) |
| | |
- Description:
- This microservice deletes an existing data object
- Module:
- core
- Since:
- pre-2.1
- Author:
- Mike Wan
- Date:
- 2007
- Note:
- Can be called by client through irule
- Example Usage:
- See clients/icommands/test/rules3.0/
- Parameters:
-
[in] | inpParam | - a msParam of type DataObjInp_MS_T or STR_MS_T which would be taken as msKeyValStr. 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 the path of the data object("objPath") for backward compatibility. Valid keyWds are:
- "objPath" - the path of the data object to remove.
- "replNum" - the replica number of the copy to remove.
- "forceFlag" - Remove the data object instead putting it in trash. This keyWd has no value. But the '=' character is still needed
- "irodsAdminRmTrash" - Admin rm trash. This keyWd has no value.
- "irodsRmTrash" - rm trash. This keyWd has no value.
- "unreg" - unregister the path. This keyWd has no value.
|
[out] | outParam | - a msParam of type INT_MS_T for 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 771 of file reDataObjOpr.c.
|