ClipboardObject.IDataObject.EnumFormatEtc Method

Article
2011-02-23

Creates an object for enumerating the FORMATETC structures for a data object. These structures are used in calls to IDataObject.GetData or IDataObject.SetData.

Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

'Declaration
Private Function EnumFormatEtc ( _
    direction As DATADIR _
) As IEnumFORMATETC Implements IDataObject.EnumFormatEtc

IEnumFORMATETC IDataObject.EnumFormatEtc(
    DATADIR direction
)

private:
virtual IEnumFORMATETC^ EnumFormatEtc(
    DATADIR direction
) sealed = IDataObject::EnumFormatEtc

private abstract EnumFormatEtc : 
        direction:DATADIR -> IEnumFORMATETC 
private override EnumFormatEtc : 
        direction:DATADIR -> IEnumFORMATETC

JScript does not support explicit interface implementations.

Parameters

direction
Type: System.Runtime.InteropServices.ComTypes.DATADIR
A value from the DATADIR enumeration that specifies the direction of the data.

Return Value

Type: System.Runtime.InteropServices.ComTypes.IEnumFORMATETC
This method supports the standard return values E_INVALIDARG and E_OUTOFMEMORY, as well as the following:

Value	Description
S_OK	The enumerator object was successfully created.
E_NOTIMPL	The direction specified by the direction parameter is not supported.
OLE_S_USEREG	Requests that OLE enumerate the formats from the registry.

Implements

IDataObject.EnumFormatEtc(DATADIR)

Remarks

This method delegates the call to the corresponding EnumFormatEtc from the System.Runtime.InteropServices.ComTypes namespace, assuming that the clipboard object is wrapping an existing IDataObject.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via