msiSetDataObjPreferredResc ( msParam_t *  xpreferredRescList,
ruleExecInfo_t *  rei 
)
Description:
If the data has multiple copies, this microservice specifies the preferred copy to use. It sets the preferred resources of the opened object.
Module:
core
Since:
pre-2.1
Author:
Mike Wan
Date:
2007
Note:
The copy stored in this preferred resource will be picked if it exists. More than one resource can be input using the character "%" as separator. e.g., resc1resc2resc3. The most preferred resource should be at the top of the list.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] xpreferredRescList - a msParam of type STR_MS_T, comma-delimited list of resources
[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:
  • rei->doinp->openFlags, rei->doi
Session Variables Modified:
  • rei->doi
iCAT Attributes Used:
none
iCAT Attributes Modified:
none
Side Effect:
none
Returns:
integer
Return values:
0 on success
Precondition:
none
Postcondition:
none
See also:
none

Definition at line 299 of file reSysDataObjOpr.c.

Generated on Tue Nov 12 23:18:34 2013 for iRODS Documentation by  doxygen 1.6.3