IExchangeFolderRules::HrGet

The HrGet method retrieves the current rule on the folder.

HRESULT HrGet(
  LPLONG lplState,                      
  LPSRestriction FAR * lppRestriction,  
  LPACTIONS FAR * lppActions,           
  LPLONG lplLevel,                      
  LPSTR FAR * lppszName                 
);
 

Parameters

lplState

Output parameter. Points to a LONG value containing the rule state.

lppRestriction

Output parameter. Points to a MAPI SRestriction structure containing the conditions for the rule.

lppActions

Output parameter. Points to an ACTIONS structure containing the actions for the rule.

lplLevel

Output parameter. Points to a LONG value containing the nesting level of the rule.

lppszName

Output parameter. Points to a string containing the name of the rule.

Return Values

See Return Values.

In addition, HrGet returns E_FAIL if one of the following conditions occurs:

An attempt was made to retrieve a rule when the cursor is at the end of the rules table (no current member).

The current cursor position, as returned by the HrTell method, is RULE_PAST_END.

Remarks

The calling program must allocate space for the variables where the lplState and lplLevel parameters point.

For additional information, see RULEEDIT: Manipulating Rules.

See Also

ACTIONS, IExchangeFolderRules