ClipboardObject.IDataObject.EnumFormatEtc(UInt32, IEnumFORMATETC) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Data.Framework

Assembly:: Microsoft.VisualStudio.Data.Framework.dll

Package:: Microsoft.VisualStudio.Data.Framework v17.10.40170

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData(FORMATETC[], STGMEDIUM[]) or IDataObject.SetData(FORMATETC[], STGMEDIUM[], Int32).

 virtual int Microsoft.VisualStudio.OLE.Interop.IDataObject.EnumFormatEtc(System::UInt32 dwDirection, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IEnumFORMATETC ^ % ppenumFormatEtc) = Microsoft::VisualStudio::OLE::Interop::IDataObject::EnumFormatEtc;

int IDataObject.EnumFormatEtc (uint dwDirection, out Microsoft.VisualStudio.OLE.Interop.IEnumFORMATETC ppenumFormatEtc);

abstract member Microsoft.VisualStudio.OLE.Interop.IDataObject.EnumFormatEtc : uint32 * IEnumFORMATETC -> int
override this.Microsoft.VisualStudio.OLE.Interop.IDataObject.EnumFormatEtc : uint32 * IEnumFORMATETC -> int

Function EnumFormatEtc (dwDirection As UInteger, ByRef ppenumFormatEtc As IEnumFORMATETC) As Integer Implements IDataObject.EnumFormatEtc

Parameters

dwDirection: UInt32

A value from the DATADIR enumeration that specifies the direction of the data.

ppenumFormatEtc: IEnumFORMATETC

Out parameter. When this method returns, contains a reference to an enumerator object used to enumerate FORMATETC structures for a data object.

Returns

Int32

This method supports the standard return values E_INVALIDARG and E_OUTOFMEMORY, as well as the following:ValueDescriptionS_OKThe enumerator object was successfully created.E_NOTIMPLThe direction specified by dwDirection is not supported.OLE_S_USEREGRequests that OLE enumerate the formats from the registry.

Implements

EnumFormatEtc(UInt32, IEnumFORMATETC)

Exceptions

NotImplementedException

The current clipboard object does not wrap an existing IDataObject (from the Microsoft.VisualStudio.OLE.Interop namespace), and the call through the System.Runtime.InteropServices.ComTypes.IDataObject interface failed.

Applies to

Share via