ClipboardObject.IDataObject.GetData(FORMATETC[], STGMEDIUM[]) Method

Definition

Namespace:

Microsoft.VisualStudio.Data.Framework

Assembly:

Microsoft.VisualStudio.Data.Framework.dll

Package:

Microsoft.VisualStudio.Data.Framework v17.10.40170

Obtains data from a source data object. This method is called by a data consumer. It renders the data described in the specified FORMATETC structure and transfers it through the specified STGMEDIUM structure. The caller then assumes responsibility for releasing the STGMEDIUM structure.

 virtual void Microsoft.VisualStudio.OLE.Interop.IDataObject.GetData(cli::array <Microsoft::VisualStudio::OLE::Interop::FORMATETC> ^ pformatetcIn, cli::array <Microsoft::VisualStudio::OLE::Interop::STGMEDIUM> ^ pRemoteMedium) = Microsoft::VisualStudio::OLE::Interop::IDataObject::GetData;

void IDataObject.GetData (Microsoft.VisualStudio.OLE.Interop.FORMATETC[] pformatetcIn, Microsoft.VisualStudio.OLE.Interop.STGMEDIUM[] pRemoteMedium);

abstract member Microsoft.VisualStudio.OLE.Interop.IDataObject.GetData : Microsoft.VisualStudio.OLE.Interop.FORMATETC[] * Microsoft.VisualStudio.OLE.Interop.STGMEDIUM[] -> unit
override this.Microsoft.VisualStudio.OLE.Interop.IDataObject.GetData : Microsoft.VisualStudio.OLE.Interop.FORMATETC[] * Microsoft.VisualStudio.OLE.Interop.STGMEDIUM[] -> unit

Sub GetData (pformatetcIn As FORMATETC(), pRemoteMedium As STGMEDIUM()) Implements IDataObject.GetData

Parameters

pformatetcIn

FORMATETC[]

A reference to a FORMATETC structure, passed by reference, that defines the format, medium, and target device to use when passing the data. It is possible to specify more than one medium by using the Boolean OR operator, allowing the method to choose the best medium among those specified.

pRemoteMedium

STGMEDIUM[]

When this method returns, contains a reference to the STGMEDIUM structure that indicates the storage medium containing the returned data through its tymed member, and the responsibility for releasing the medium through the value of its pUnkForRelease member. If pUnkForRelease is null, the receiver of the medium is responsible for releasing it; otherwise, pUnkForRelease points to the IUnknown interface on the appropriate object so its Release method can be called. The medium must be allocated and filled in by this method. This parameter is passed uninitialized.

Implements

GetData(FORMATETC[], STGMEDIUM[])

Exceptions

ArgumentNullException

The clipboard object is not a wrapped Microsoft.VisualStudio.OLE.Interop.IDataObject and the pformatetcIn and/or pRemoteMedium parameters are null.

ArgumentException

The clipboard object is not a wrapped Microsoft.VisualStudio.OLE.Interop.IDataObject and the length of the pformatetcIn and/or pRemoteMedium structures are zero.