|
msiGetRulesFromDBIntoStruct |
( |
msParam_t * |
inIrbBaseNameParam, |
|
|
msParam_t * |
inVersionParam, |
|
|
msParam_t * |
outCoreRuleStruct, |
|
|
ruleExecInfo_t * |
rei | |
|
) |
| | |
- Description:
- This is a microservice that queries the iCAT for rules with a given base name and version number and populates a rule structure with those rules.
- Module:
- core
- Since:
- 2.5
- Author:
- Arcot Rajasekar
- Date:
- 2010
- Note:
- This microservice requires iRODS administration privileges.
-
Queries rules from the iCAT rule base.
- Example Usage:
- See clients/icommands/test/rules3.0/
- Parameters:
-
[in] | inIrbBaseNameParam | - a msParam of type STR_MS_T, which is the name of the base that is being queried. |
[in] | inVersionParam | - a msParam of type STR_MS_T, which is the version string of the base being queried (use 0 for current version) |
[out] | outCoreRuleStruct | - a msParam of type RuleStruct_MS_T (can be NULL in which case it is allocated) |
[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:
- msiAdmReadRulesFromFileIntoStruct, msiAdmInsertRulesFromStructIntoDB, msiAdmWriteRulesFromStructIntoFile
Definition at line 567 of file ruleAdminMS.c.
|