ClipboardObject.IDataObject.DAdvise Method

Article
10/02/2013

Creates a connection between the clipboard 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.

Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Private Function DAdvise ( _
    ByRef pFormatetc As FORMATETC, _
    advf As ADVF, _
    adviseSink As IAdviseSink, _
    <OutAttribute> ByRef connection As Integer _
) As Integer Implements IDataObject.DAdvise

int IDataObject.DAdvise(
    ref FORMATETC pFormatetc,
    ADVF advf,
    IAdviseSink adviseSink,
    out int connection
)

private:
virtual int DAdvise(
    FORMATETC% pFormatetc, 
    ADVF advf, 
    IAdviseSink^ adviseSink, 
    [OutAttribute] int% connection
) sealed = IDataObject::DAdvise

private abstract DAdvise : 
        pFormatetc:FORMATETC byref * 
        advf:ADVF * 
        adviseSink:IAdviseSink * 
        connection:int byref -> int  
private override DAdvise : 
        pFormatetc:FORMATETC byref * 
        advf:ADVF * 
        adviseSink:IAdviseSink * 
        connection:int byref -> int

JScript does not support explicit interface implementations.

Parameters

pFormatetc
Type: System.Runtime.InteropServices.ComTypes.FORMATETC%

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

advf
Type: System.Runtime.InteropServices.ComTypes.ADVF

A value from the ADVF enumeration that specifies a group of flags for controlling the advisory connection.

adviseSink
Type: System.Runtime.InteropServices.ComTypes.IAdviseSink

An IAdviseSink object pointing to the advisory sink that will receive the change notification.

connection
Type: System.Int32%

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

Return Value

Type: System.Int32
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.

Implements

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

Remarks

This method delegates the call to the corresponding DAdvise from the System.Runtime.InteropServices.ComTypes namespace, assuming that the clipboard object is wrapping an existing IDataObject.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Partager via