-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
EventDescriptor.xml
289 lines (279 loc) · 17.1 KB
/
EventDescriptor.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<Type Name="EventDescriptor" FullName="System.Diagnostics.Eventing.EventDescriptor">
<TypeSignature Language="C#" Value="public struct EventDescriptor" />
<TypeSignature Language="ILAsm" Value=".class public ansi sealed beforefieldinit EventDescriptor extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Diagnostics.Eventing.EventDescriptor" />
<TypeSignature Language="VB.NET" Value="Public Structure EventDescriptor" />
<TypeSignature Language="F#" Value="type EventDescriptor = struct" />
<TypeSignature Language="C++ CLI" Value="public value class EventDescriptor" />
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Contains the metadata that defines an event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class represents an event defined in the manifest. After writing your manifest, you use the Message Compiler (MC.exe) to generate a resource file. A byproduct of the process is a header file that contains the event descriptor in C, as shown in the following example.
```
EXTERN_C __declspec(selectany) const EVENT_DESCRIPTOR ReadEvent = {0x1, 0x0, 0x10, 0x4, 0x0, 0x0, 0x8000000000000005};
```
Use the values of the descriptor to create an instance of this class, as shown in the following example. The keyword is an unsigned long value and cannot be cast directly to a long; you must use the `unchecked` language keyword to allow the assignment.
```
unchecked
{
readEvent = new EventDescriptor(0x1, 0x0, 0x10, 0x4, 0x0, 0x0, (long)0x8000000000000005);
}
```
You use the descriptor when calling the <xref:System.Diagnostics.Eventing.EventProvider.WriteEvent%2A?displayProperty=nameWithType> or <xref:System.Diagnostics.Eventing.EventProvider.WriteEvent%2A?displayProperty=nameWithType> method.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventDescriptor (int id, byte version, byte channel, byte level, byte opcode, int task, long keywords);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 id, unsigned int8 version, unsigned int8 channel, unsigned int8 level, unsigned int8 opcode, int32 task, int64 keywords) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Diagnostics.Eventing.EventDescriptor.#ctor(System.Int32,System.Byte,System.Byte,System.Byte,System.Byte,System.Int32,System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (id As Integer, version As Byte, channel As Byte, level As Byte, opcode As Byte, task As Integer, keywords As Long)" />
<MemberSignature Language="F#" Value="new System.Diagnostics.Eventing.EventDescriptor : int * byte * byte * byte * byte * int * int64 -> System.Diagnostics.Eventing.EventDescriptor" Usage="new System.Diagnostics.Eventing.EventDescriptor (id, version, channel, level, opcode, task, keywords)" />
<MemberSignature Language="C++ CLI" Value="public:
 EventDescriptor(int id, System::Byte version, System::Byte channel, System::Byte level, System::Byte opcode, int task, long keywords);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="id" Type="System.Int32" />
<Parameter Name="version" Type="System.Byte" />
<Parameter Name="channel" Type="System.Byte" />
<Parameter Name="level" Type="System.Byte" />
<Parameter Name="opcode" Type="System.Byte" />
<Parameter Name="task" Type="System.Int32" />
<Parameter Name="keywords" Type="System.Int64" />
</Parameters>
<Docs>
<param name="id">The event identifier.</param>
<param name="version">Version of the event. The version indicates a revision to the event definition. You can use this member and the Id member to identify a unique event.</param>
<param name="channel">Defines a potential target for the event.</param>
<param name="level">Specifies the level of detail included in the event.</param>
<param name="opcode">Operation being performed at the time the event is written.</param>
<param name="task">Identifies a logical component of the application that is writing the event.</param>
<param name="keywords">Bit mask that specifies the event category. The keyword can contain one or more provider-defined keywords, standard keywords, or both.</param>
<summary>Initializes a new instance of the <see cref="T:System.Diagnostics.Eventing.EventDescriptor" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For details on these parameters, see the attributes of the [EventDefinitionType](/windows/win32/wes/eventmanifestschema-eventdefinitiontype-complextype) complex type.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Channel">
<MemberSignature Language="C#" Value="public byte Channel { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8 Channel" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Eventing.EventDescriptor.Channel" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Channel As Byte" />
<MemberSignature Language="F#" Value="member this.Channel : byte" Usage="System.Diagnostics.Eventing.EventDescriptor.Channel" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Byte Channel { System::Byte get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the channel value from the event descriptor.</summary>
<value>The channel that defines a potential target for the event.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EventId">
<MemberSignature Language="C#" Value="public int EventId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 EventId" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Eventing.EventDescriptor.EventId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EventId As Integer" />
<MemberSignature Language="F#" Value="member this.EventId : int" Usage="System.Diagnostics.Eventing.EventDescriptor.EventId" />
<MemberSignature Language="C++ CLI" Value="public:
 property int EventId { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the event identifier value from the event descriptor.</summary>
<value>The event identifier.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Keywords">
<MemberSignature Language="C#" Value="public long Keywords { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Keywords" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Eventing.EventDescriptor.Keywords" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Keywords As Long" />
<MemberSignature Language="F#" Value="member this.Keywords : int64" Usage="System.Diagnostics.Eventing.EventDescriptor.Keywords" />
<MemberSignature Language="C++ CLI" Value="public:
 property long Keywords { long get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the keyword value from the event descriptor.</summary>
<value>The keyword, which is a bit mask, that specifies the event category.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Level">
<MemberSignature Language="C#" Value="public byte Level { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8 Level" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Eventing.EventDescriptor.Level" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Level As Byte" />
<MemberSignature Language="F#" Value="member this.Level : byte" Usage="System.Diagnostics.Eventing.EventDescriptor.Level" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Byte Level { System::Byte get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the level value from the event descriptor.</summary>
<value>The level of detail included in the event.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Opcode">
<MemberSignature Language="C#" Value="public byte Opcode { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8 Opcode" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Eventing.EventDescriptor.Opcode" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Opcode As Byte" />
<MemberSignature Language="F#" Value="member this.Opcode : byte" Usage="System.Diagnostics.Eventing.EventDescriptor.Opcode" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Byte Opcode { System::Byte get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the operation code value from the event descriptor.</summary>
<value>The operation being performed at the time the event is written.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Task">
<MemberSignature Language="C#" Value="public int Task { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Task" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Eventing.EventDescriptor.Task" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Task As Integer" />
<MemberSignature Language="F#" Value="member this.Task : int" Usage="System.Diagnostics.Eventing.EventDescriptor.Task" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Task { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the task value from the event descriptor.</summary>
<value>The task that identifies the logical component of the application that is writing the event.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public byte Version { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int8 Version" />
<MemberSignature Language="DocId" Value="P:System.Diagnostics.Eventing.EventDescriptor.Version" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Version As Byte" />
<MemberSignature Language="F#" Value="member this.Version : byte" Usage="System.Diagnostics.Eventing.EventDescriptor.Version" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Byte Version { System::Byte get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Core</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>Retrieves the version value from the event descriptor.</summary>
<value>The version of the event.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The version indicates a revision to the event definition. You can use this member and the Id member to identify a unique event.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>