Skip to content
Permalink
Fetching contributors…
Cannot retrieve contributors at this time
290 lines (273 sloc) 15.1 KB
<Type Name="FORMATETC" FullName="System.Runtime.InteropServices.ComTypes.FORMATETC">
<TypeSignature Language="C#" Value="public struct FORMATETC" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit FORMATETC extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Runtime.InteropServices.ComTypes.FORMATETC" />
<TypeSignature Language="VB.NET" Value="Public Structure FORMATETC" />
<TypeSignature Language="C++ CLI" Value="public value class FORMATETC" />
<TypeSignature Language="F#" Value="type FORMATETC = struct" />
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netstandard-1.5;netstandard-1.6;netcore-2.2;dotnet-uwp-10.0;netcore-3.0;netstandard-2.1;netcore-3.1">
<AttributeName>System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netstandard-1.2;netstandard-1.3;netstandard-1.4">
<AttributeName>System.ComponentModel.EditorBrowsable</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a generalized Clipboard format.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Runtime.InteropServices.ComTypes.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](~/docs/framework/interop/how-to-map-hresults-and-exceptions.md).
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="cfFormat">
<MemberSignature Language="C#" Value="public short cfFormat;" />
<MemberSignature Language="ILAsm" Value=".field public int16 cfFormat" />
<MemberSignature Language="DocId" Value="F:System.Runtime.InteropServices.ComTypes.FORMATETC.cfFormat" />
<MemberSignature Language="VB.NET" Value="Public cfFormat As Short " />
<MemberSignature Language="C++ CLI" Value="public: short cfFormat;" />
<MemberSignature Language="F#" Value="val mutable cfFormat : int16" Usage="System.Runtime.InteropServices.ComTypes.FORMATETC.cfFormat" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int16</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies the particular clipboard format of interest.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
OLE recognizes three formats:
- Standard interchange formats, such as `CF_TEXT`.
- Private application formats understood only by the application offering the format, or by other applications offering similar features.
- OLE formats, which are used to create linked or embedded objects.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="dwAspect">
<MemberSignature Language="C#" Value="public System.Runtime.InteropServices.ComTypes.DVASPECT dwAspect;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype System.Runtime.InteropServices.ComTypes.DVASPECT dwAspect" />
<MemberSignature Language="DocId" Value="F:System.Runtime.InteropServices.ComTypes.FORMATETC.dwAspect" />
<MemberSignature Language="VB.NET" Value="Public dwAspect As DVASPECT " />
<MemberSignature Language="C++ CLI" Value="public: System::Runtime::InteropServices::ComTypes::DVASPECT dwAspect;" />
<MemberSignature Language="F#" Value="val mutable dwAspect : System.Runtime.InteropServices.ComTypes.DVASPECT" Usage="System.Runtime.InteropServices.ComTypes.FORMATETC.dwAspect" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Runtime.InteropServices.ComTypes.DVASPECT</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies one of the <see cref="T:System.Runtime.InteropServices.ComTypes.DVASPECT" /> enumeration constants that indicates how much detail should be contained in the rendering.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A single clipboard format can support multiple aspects or views of the object. Most data and presentation transfer and caching methods pass aspect information. For example, a caller might request an object's iconic picture, using the metafile clipboard format to retrieve it. Note that only one <xref:System.Runtime.InteropServices.ComTypes.DVASPECT> value can be used in <xref:System.Runtime.InteropServices.ComTypes.FORMATETC.dwAspect>. That is, <xref:System.Runtime.InteropServices.ComTypes.FORMATETC.dwAspect> cannot be the result of a `BOOLEAN OR` operation on several <xref:System.Runtime.InteropServices.ComTypes.DVASPECT> values.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="lindex">
<MemberSignature Language="C#" Value="public int lindex;" />
<MemberSignature Language="ILAsm" Value=".field public int32 lindex" />
<MemberSignature Language="DocId" Value="F:System.Runtime.InteropServices.ComTypes.FORMATETC.lindex" />
<MemberSignature Language="VB.NET" Value="Public lindex As Integer " />
<MemberSignature Language="C++ CLI" Value="public: int lindex;" />
<MemberSignature Language="F#" Value="val mutable lindex : int" Usage="System.Runtime.InteropServices.ComTypes.FORMATETC.lindex" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies part of the aspect when the data must be split across page boundaries.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The most common value is -1, which identifies all of the data. For the aspects <xref:System.Runtime.InteropServices.ComTypes.DVASPECT.DVASPECT_THUMBNAIL> and <xref:System.Runtime.InteropServices.ComTypes.DVASPECT.DVASPECT_ICON>, <xref:System.Runtime.InteropServices.ComTypes.FORMATETC.lindex> is ignored.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ptd">
<MemberSignature Language="C#" Value="public IntPtr ptd;" />
<MemberSignature Language="ILAsm" Value=".field public native int ptd" />
<MemberSignature Language="DocId" Value="F:System.Runtime.InteropServices.ComTypes.FORMATETC.ptd" />
<MemberSignature Language="VB.NET" Value="Public ptd As IntPtr " />
<MemberSignature Language="C++ CLI" Value="public: IntPtr ptd;" />
<MemberSignature Language="F#" Value="val mutable ptd : nativeint" Usage="System.Runtime.InteropServices.ComTypes.FORMATETC.ptd" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies a pointer to a <see langword="DVTARGETDEVICE" /> structure containing information about the target device that the data is being composed for.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A null value is used whenever the specified data format is independent of the target device or when the caller does not care what device is used. In the latter case, if the data requires a target device, the object should pick an appropriate default device (often the display for visual components). Data obtained from an object with a null target device, such as most metafiles, is independent of the target device. The resulting data is usually the same as it would be if the user chose the **Save As** command from the **File** menu and selected an interchange format.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="tymed">
<MemberSignature Language="C#" Value="public System.Runtime.InteropServices.ComTypes.TYMED tymed;" />
<MemberSignature Language="ILAsm" Value=".field public valuetype System.Runtime.InteropServices.ComTypes.TYMED tymed" />
<MemberSignature Language="DocId" Value="F:System.Runtime.InteropServices.ComTypes.FORMATETC.tymed" />
<MemberSignature Language="VB.NET" Value="Public tymed As TYMED " />
<MemberSignature Language="C++ CLI" Value="public: System::Runtime::InteropServices::ComTypes::TYMED tymed;" />
<MemberSignature Language="F#" Value="val mutable tymed : System.Runtime.InteropServices.ComTypes.TYMED" Usage="System.Runtime.InteropServices.ComTypes.FORMATETC.tymed" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.InteropServices</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.20.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.2.0.0</AssemblyVersion>
<AssemblyVersion>4.2.1.0</AssemblyVersion>
<AssemblyVersion>4.2.2.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.0.5.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>netstandard</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Runtime.InteropServices.ComTypes.TYMED</ReturnType>
</ReturnValue>
<Docs>
<summary>Specifies one of the <see cref="T:System.Runtime.InteropServices.ComTypes.TYMED" /> enumeration constants, which indicates the type of storage medium used to transfer the object's data.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Data can be transferred using whatever medium makes sense for the object. For example, data can be passed using global memory, a disk file, or structured storage objects. For more information, see the <xref:System.Runtime.InteropServices.ComTypes.TYMED> enumeration.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.