IDataObject.DAdvise(FORMATETC, ADVF, IAdviseSink, Int32) Method

Definition

Creates a connection between a data object and an advisory sink. This method is called by an object that supports an advisory sink and enables the advisory sink to be notified of changes in the object's data.

public:
 int DAdvise(System::Runtime::InteropServices::ComTypes::FORMATETC % pFormatetc, System::Runtime::InteropServices::ComTypes::ADVF advf, System::Runtime::InteropServices::ComTypes::IAdviseSink ^ adviseSink, [Runtime::InteropServices::Out] int % connection);
public int DAdvise (ref System.Runtime.InteropServices.ComTypes.FORMATETC pFormatetc, System.Runtime.InteropServices.ComTypes.ADVF advf, System.Runtime.InteropServices.ComTypes.IAdviseSink adviseSink, out int connection);
abstract member DAdvise : FORMATETC * System.Runtime.InteropServices.ComTypes.ADVF * System.Runtime.InteropServices.ComTypes.IAdviseSink * int -> int

Parameters

pFormatetc
FORMATETC

A FORMATETC structure, passed by reference, that defines the format, target device, aspect, and medium that will be used for future notifications.

advf
ADVF

One of the ADVF values that specifies a group of flags for controlling the advisory connection.

adviseSink
IAdviseSink

A pointer to the IAdviseSink interface on the advisory sink that will receive the change notification.

connection
Int32

When this method returns, contains a pointer to a DWORD token that identifies this connection. You can use this token later to delete the advisory connection by passing it to DUnadvise(Int32). If this value is zero, the connection was not established. This parameter is passed uninitialized.

Returns

This method supports the standard return values E_INVALIDARG, E_UNEXPECTED, and E_OUTOFMEMORY, as well as the following:

Value Description
S_OK The advisory connection was created.
E_NOTIMPL This method is not implemented on the data object.
DV_E_LINDEX There is an invalid value for lindex; currently, only -1 is supported.
DV_E_FORMATETC There is an invalid value for the pFormatetc parameter.
OLE_E_ADVISENOTSUPPORTED The data object does not support change notification.

Remarks

For more information about IDataObject::DAdvise, see the MSDN Library.

Applies to