IOleObject::Unadvise method (oleidl.h)

Article
02/22/2024

Deletes a previously established advisory connection.

Syntax

HRESULT Unadvise(
  [in] DWORD dwConnection
);

Parameters

[in] dwConnection

Contains a token of nonzero value, which was previously returned from IOleObject::Advise through its pdwConnection parameter.

Return value

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

Return code	Description
E_FAIL	The operation failed.
OLE_E_NOCONNECTION	dwConnection does not represent a valid advisory connection.

Remarks

Normally, containers call IOleObject::Unadvise at shutdown or when an object is deleted. In certain cases, containers can call this method on objects that are running but not currently visible as a way of reducing the overhead of maintaining multiple advisory connections. The easiest way to implement this method is to delegate the call to IOleObject::Unadvise.

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