HrCfgCreateAdviseObj

The HrCfgCreateAdviseObj function monitors a MAPI session for changes to the extension data.

Quick Info

Header file: EDKCFG.H
Library: EDKCFG.LIB 

HRESULT HrCfgCreateAdviseObj(
  LPMAPISESSION lpSession,  
  ULONG nPollInterval,      
  LPADVISEOBJ * lppAdviseObj  
);

Parameters

lpSession
Input parameter. Points to a MAPI IMAPISession interface containing the MAPI session to monitor.
nPollInterval
Input parameter. Specifies the interval (in milliseconds) between polling.
lppAdviseObj
Output parameter. Points to a pointer to the ADVISEOBJ structure containing created advise object.

Return Values

See Return Values.

Remarks

The HrCfgCreateAdviseObj function should be called once to create an advise object for a MAPI session that is being monitored. Then, you should call HrCfgAdvise once for each extension data section that is being monitored. If nPollInterval == 0, then no monitoring thread is created, and the user must do polling manually by calling HrCfgPollAdviseObj.

For more information on this function, see Using the Configuration Functions.

For information on the IMAPISession interface, see the MAPI Programmer's Reference.

See Also

HrCfgDestroyAdviseObj, HrCfgUnadvise