Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
FORMATETC Structure

FORMATETC Structure

Represents a generalized Clipboard format.

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

public value class FORMATETC

The FORMATETC type exposes the following members.

  NameDescription
Public methodEqualsIndicates whether this instance and a specified object are equal. (Inherited from ValueType.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from ValueType.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns the fully qualified type name of this instance. (Inherited from ValueType.)
Top

  NameDescription
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.
Top

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.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

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