This method deletes a previously established advisory connection.
At a Glance
Header file: | Oleidl.h |
Windows CE versions: | 2.0 and later |
Syntax
HRESULT Unadvise( DWORD dwConnection );
Parameters
dwConnection
[in] Contains a nonzero DWORD previously returned by IOleAdviseHolder::Advise in pdwConnection.
Return Values
One of the values described in the following table is returned.
Value | Description |
S_OK | Advisory connection deleted successfully. |
OLE_E_NOCONNECTION | The dwConnection parameter does not represent a valid advisory connection. |
Remarks
IOleAdviseHolder::Unadvise is intended to be used to implement IOleObject::Unadvise to delete an advisory connection. In general, you would use the OLE advise holder having obtained a pointer through a call to CreateOleAdviseHolder.
Usually, containers call this method at shutdown or when an object is deleted. In certain cases, containers could call this method on objects that are running but not currently visible, as a way of reducing the overhead of maintaining multiple advisory connections.