IDataObject.GetData Method (FORMATETC, STGMEDIUM)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Obtains data from a source data object. The GetData 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.

Namespace:   System.Runtime.InteropServices.ComTypes
Assembly:  System (in System.dll)

void GetData(
	[InAttribute] ref FORMATETC format,
	out STGMEDIUM medium


Type: System.Runtime.InteropServices.ComTypes.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.

Type: System.Runtime.InteropServices.ComTypes.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. This parameter is passed uninitialized.

For more information about IDataObject::GetData, see the MSDN Library.

.NET Framework
Available since 2.0
Return to top