ClipboardObject.IDataObject.QueryGetData Method

Article
2011-02-23

Determines whether the data object is capable of rendering the data described in the FORMATETC structure. Objects attempting a paste or drop operation can call this method before calling IDataObject.GetData to get an indication of whether the operation will be successful.

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

Syntax

'Declaration
Private Function QueryGetData ( _
    ByRef format As FORMATETC _
) As Integer Implements IDataObject.QueryGetData

int IDataObject.QueryGetData(
    ref FORMATETC format
)

private:
virtual int QueryGetData(
    FORMATETC% format
) sealed = IDataObject::QueryGetData

private abstract QueryGetData : 
        format:FORMATETC byref -> int 
private override QueryGetData : 
        format:FORMATETC byref -> int

JScript does not support explicit interface implementations.

Parameters

format
Type: System.Runtime.InteropServices.ComTypes.FORMATETC%
A reference to a FORMATETC structure, passed by reference, that defines the format, medium, and target device to use for the query.

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	A subsequent call to GetData will probably be successful.
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 format parameter.
DV_E_TYMED	There is an invalid tymed value.
DV_E_DVASPECT	There is an invalid dwAspect value.
OLE_E_NOTRUNNING	The application is not running.

Implements

IDataObject.QueryGetData(FORMATETC%)

Remarks

This method delegates the call to the corresponding QueryGetData 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.

Share via