HrFolderRulesOpen

The HrFolderRulesOpen function gets a pointer to an IExchangeFolderRules interface object.

Quick Info

Header file: RULECLS.H
Library: RULECLS.LIB 

HRESULT HrFolderRulesOpen(
  LPMDB lpMDB,                        
  ULONG cbentryid,                    
  LPENTRYID lpentryid,                
  LPSTR lpszProvider,                 
  LPFOLDERRULES FAR * lppFolderRules  
);

Parameters

lpMDB
Input parameter. Points to a MAPI IMsgStore interface containing the message store with the folder.
cbentryid
Input parameter. Specifies the number of bytes in the folder's entry identifier pointed to by lpentryid.
lpentryid
Input parameter. Points to an ENTRYID structure containing the folder's entry identifier.
lpszProvider
Input Parameter. Points to a STRING8 containing the name of the provider for the requested rules.
lppFolderRules
Output parameter. Points to a pointer to an IExchangeFolderRules interface object.

Return Values

See Return Values. In addition, HrFolderRulesOpen can return the following value:

E_NOINTERFACE
The rules table does not exist on the folder.

Remarks

Because more than one provider can have rules on a folder, use the IExchangeFolderRules interface to access the rules associated with a specific provider. For more information on HrFolderRulesOpen function, see Working with Rules.

For information on the ENTRYID structure and the IMsgStore interface, see the MAPI Programmer's Reference.

See Also

HrFolderRulesGetProviders