DataObject.IDataObject.GetData(FORMATETC, STGMEDIUM) Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

DataObject.cs

Obtains data from a source data object. The GetData(FORMATETC, STGMEDIUM) method, which is called by a data consumer, 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 System.Runtime.InteropServices.ComTypes.IDataObject.GetData(System::Runtime::InteropServices::ComTypes::FORMATETC % formatetc, [Runtime::InteropServices::Out] System::Runtime::InteropServices::ComTypes::STGMEDIUM % medium) = System::Runtime::InteropServices::ComTypes::IDataObject::GetData;

void IDataObject.GetData (ref System.Runtime.InteropServices.ComTypes.FORMATETC formatetc, out System.Runtime.InteropServices.ComTypes.STGMEDIUM medium);

abstract member System.Runtime.InteropServices.ComTypes.IDataObject.GetData : FORMATETC * STGMEDIUM -> unit
override this.System.Runtime.InteropServices.ComTypes.IDataObject.GetData : FORMATETC * STGMEDIUM -> unit

Sub GetData (ByRef formatetc As FORMATETC, ByRef medium As STGMEDIUM) Implements IDataObject.GetData

Parameters

formatetc

FORMATETC

A pointer 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.

medium

STGMEDIUM

When this method returns, contains a pointer 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 GetData(FORMATETC, STGMEDIUM). This parameter is passed uninitialized.

Implements

GetData(FORMATETC, STGMEDIUM)

Exceptions

OutOfMemoryException

There is not enough memory to perform this operation.

Remarks

This member is an explicit interface member implementation. It can be used only when the DataObject is cast to an IDataObject interface.