msiGetFNMapsFromDBIntoStruct ( msParam_t *  inFnmBaseNameParam,
msParam_t *  inVersionParam,
msParam_t *  outCoreFNMapStruct,
ruleExecInfo_t *  rei 
)
Description:
Populates a FNM structure with FNMs from the given base name
Module:
core
Since:
after 2.5
Author:
Arcot Rajasekar
Date:
2011
Note:
This microservice requires iRODS administration privileges.
This is a microservice that queries the iCAT for FNM with a given base name and version number and populates a FNM rule structure.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inFnmBaseNameParam - a msParam of type STR_MS_T, the name of the base 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)
[in] outCoreFNMapStruct - a msParam of type RuleStruct_MS_T
[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:
0 on success
Precondition:
none
Postcondition:
none
See also:
msiAdmReadFNMapsFromFileIntoStruct, msiAdmInsertFNMapsFromStructIntoDB, msiAdmWriteFNMapsFromStructIntoFile

Definition at line 1296 of file ruleAdminMS.c.

Generated on Mon Jun 25 14:02:15 2012 for iRODS Documentation by  doxygen 1.6.3