This documentation is archived and is not being maintained.


Represents a generalized Clipboard format.

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

public struct FORMATETC

The FORMATETC type exposes the following members.

Public methodEqualsIndicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from ValueType.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)

Public fieldcfFormatSpecifies the particular clipboard format of interest.
Public fielddwAspectSpecifies one of the DVASPECT enumeration constants that indicates how much detail should be contained in the rendering.
Public fieldlindexSpecifies part of the aspect when the data must be split across page boundaries.
Public fieldptdSpecifies a pointer to a DVTARGETDEVICE structure containing information about the target device that the data is being composed for.
Public fieldtymedSpecifies one of the TYMED enumeration constants, which indicates the type of storage medium used to transfer the object's data.

The FORMATETC structure encompass a target device, the aspect or view of the data, and a storage medium indicator. Instead of a Clipboard format, OLE uses a FORMATETC data structure instead. This structure is used as a parameter in OLE functions and methods that require data format information.

For more information about the FORMATETC structure, see the MSDN Library.

The common language runtime throws an exception when a COM method in native code returns an HRESULT. For more information, see How to: Map HRESULTs and Exceptions.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.