IOleAdviseHolder::Unadvise
A version of this page is also available for
4/8/2010
This method deletes a previously established advisory connection.
Syntax
HRESULT Unadvise(
DWORD dwConnection
);
Parameters
- dwConnection
[in] Contains a nonzero DWORD previously returned by IOleAdviseHolder::Advise in pdwConnection.
Return Value
If the advisory connection deleted successfully, the return value is S_OK.
If dwConnection parameter does not represent a valid advisory connection, the return value is OLE_E_NOCONNECTION.
Remarks
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 visible, as a way of reducing the overhead of maintaining multiple advisory connections.
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Requirements
| Header | Oleidl.h, oleidl.idl |
| Library | oleaut32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |
See Also
Reference
IOleAdviseHolder
CreateOleAdviseHolder
IOleAdviseHolder::Advise
IOleObject::Unadvise