IOleAdviseHolder::Unadvise method (oleidl.h)

Article
07/27/2022

Deletes a previously established advisory connection.

Syntax

HRESULT Unadvise(
  [in] DWORD dwConnection
);

Parameters

[in] dwConnection

The value previously returned by IOleAdviseHolder::Advise in pdwConnection.

Return value

This method returns S_OK on success. Other possible return values include the following.

Return code	Description
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.

Typically, 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.

Requirements

Requirement	Value
Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Target Platform	Windows
Header	oleidl.h