IMAPITable::Unadvise

The IMAPITable::Unadvise method cancels the sending of notifications previously set up with a call to the IMAPITable::Advise method.

Quick Info

See IMAPITable : IUnknown.

HRESULT Unadvise(
  ULONG ulConnection  
);
 

Parameters

ulConnection

[in] Number of the registration connection returned by a call to IMAPITable::Advise.

Return Value

S_OK

The call succeeded and has returned the expected value or values.

Remarks

Use the IMAPITable::Unadvise method to release the pointer to the advise sink object passed in the lpAdviseSink parameter in the previous call to IMAPITable::Advise, thereby canceling a notification registration. As part of discarding the pointer to the advise sink object, the object's IUnknown::Release method is called. Generally, Release is called during the Unadvise call, but if another thread is in the process of calling the IMAPIAdviseSink::OnNotify method for the advise sink, the Release call is delayed until the OnNotify method returns.

For more information on the notification process, see Event Notification in MAPI. For specific information about table notification, see About Table Notifications. For information about using the IMAPISupport methods to support notification, see Supporting Event Notification.

See Also

IMAPIAdviseSink::OnNotify, IMAPITable::Advise