Export (0) Print
Expand All

EventAttribute Class

.NET Framework 4.5

Specifies additional event schema information for an event.

System.Object
  System.Attribute
    System.Diagnostics.Tracing.EventAttribute

Namespace:  System.Diagnostics.Tracing
Assemblies:   mscorlib (in mscorlib.dll)
  System.Diagnostics.Tracing (in System.Diagnostics.Tracing.dll)

[AttributeUsageAttribute(AttributeTargets.Method)]
public sealed class EventAttribute : Attribute

The EventAttribute type exposes the following members.

  NameDescription
Public methodEventAttributeInitializes a new instance of the EventAttribute class with the specified event identifier.
Top

  NameDescription
Public propertyActivityOptionsSpecifies the behavior of the start and stop events of an activity. An activity is the region of time in an app between the start and the stop.
Public propertyChannelGets or sets an additional event log where the event should be written.
Public propertyEventIdGets or sets the identifier for the event.
Public propertyKeywordsGets or sets the keywords for the event.
Public propertyLevelGets or sets the level for the event.
Public propertyMessageGets or sets the message for the event.
Public propertyOpcodeGets or sets the operation code for the event.
Public propertyTagsGets and sets the EventTags value for this EventAttribute object. An event tag is a user-defined value that is passed through when the event is logged.
Public propertyTaskGets or sets the task for the event.
Public propertyTypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Public propertyVersionGets or sets the version of the event.
Top

  NameDescription
Public methodEqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public methodMatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate method_Attribute.GetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.GetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method_Attribute.InvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top

When you apply this attribute to an ETW event method defined on an EventSource-derived class, you must call the WriteEvent method on the base class, passing the event ID, followed by the same arguments as the defined method is passed. You should follow the pattern shown in the following examples.

The following example shows how to use the EventAttribute class to define a variety of events. This code example is part of a larger example provided for the EventSource class.

[Event(1, Message = "Application Failure: {0}", Level = EventLevel.Error, Keywords = Keywords.Diagnostic)]
public void Failure(string message) { WriteEvent(1, message); }
[Event(2, Message = "Starting up.", Keywords = Keywords.Perf, Level = EventLevel.Informational)]
public void Startup() { WriteEvent(2); }
[Event(3, Message = "loading page {1} activityID={0}", Opcode = EventOpcode.Start, 
    Task = Tasks.Page, Keywords = Keywords.Page, Level = EventLevel.Informational)]
public void PageStart(int ID, string url) { if (IsEnabled()) WriteEvent(3, ID, url); }
[Event(4, Opcode = EventOpcode.Stop, Task = Tasks.Page, Keywords = Keywords.Page, Level = EventLevel.Informational)]
public void PageStop(int ID) { if (IsEnabled()) WriteEvent(4, ID); }

.NET Framework

Supported in: 4.6, 4.5

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