Edit

IDataObject.GetData(FORMATETC, STGMEDIUM) Method

  • Reference

Definition

Namespace:
System.Runtime.InteropServices.ComTypes
Assembly:
System.Runtime.InteropServices.dll
Assembly:
System.dll
Assembly:
netstandard.dll

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.

public:
 void GetData(System::Runtime::InteropServices::ComTypes::FORMATETC % format, [Runtime::InteropServices::Out] System::Runtime::InteropServices::ComTypes::STGMEDIUM % medium);
public void GetData (ref System.Runtime.InteropServices.ComTypes.FORMATETC format, out System.Runtime.InteropServices.ComTypes.STGMEDIUM medium);
abstract member GetData : FORMATETC * STGMEDIUM -> unit
Public Sub GetData (ByRef format As FORMATETC, ByRef medium As STGMEDIUM)

Parameters

format
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.

Remarks

For more information, see IDataObject::GetData method.

Applies to