msiSetGraftPathScheme ( msParam_t *  xaddUserName,
msParam_t *  xtrimDirCnt,
ruleExecInfo_t *  rei 
)
Description:
This microservice sets the VaultPath scheme to GRAFT_PATH. It grafts (adds) the logical path to the vault path of the resource when generating the physical path for a data object.
Module:
core
Since:
pre-2.1
Author:
Mike Wan
Date:
2007
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] xaddUserName - This msParam specifies whether the userName should be added to the physical path. e.g. $vaultPath/$userName/$logicalPath. "xaddUserName" can have two values - yes or no.
[in] xtrimDirCnt - This msParam specifies the number of leading directory elements of the logical path to trim. Sometimes it may not be desirable to graft the entire logical path. e.g.,for a logicalPath /myZone/home/me/foo/bar, it may be desirable to graft just the part "foo/bar" to the vaultPath. "xtrimDirCnt" should be set to 3 in this case.
[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->inOutMsParamArray (label == VAULT_PATH_POLICY)
Session Variables Modified:
  • rei->inOutMsParamArray (label == VAULT_PATH_POLICY)
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 1305 of file reSysDataObjOpr.c.

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