|
msiIsColl |
( |
msParam_t * |
targetPath, |
|
|
msParam_t * |
collId, |
|
|
msParam_t * |
status, |
|
|
ruleExecInfo_t * |
rei | |
|
) |
| | |
- Description:
- Checks if an iRODS path is a collection. For use in workflows.
- Module:
- ERA
- Since:
- 2.1
- Author:
- Antoine de Torcy
- Date:
- 2009-05-08
- Note:
- This microservice takes an iRODS path and returns the corresponding collection ID, or zero if the object is not a collection or does not exist. Avoid path names ending with '/' as they can be misparsed by lower level routines (eg: use /tempZone/home instead of /tempZone/home/).
- Example Usage:
- See clients/icommands/test/rules3.0/
- Parameters:
-
[in] | targetPath | - An msParam_t of any type whose inOutStruct is a string (the object's path). |
[out] | collId | - an INT_MS_T containing the collection ID. |
[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:
-
- Precondition:
- None
- Postcondition:
- None
- See also:
- None
Definition at line 53 of file collInfoMS.c.
|