EventSourceAttribute Class

Definition

Allows the event tracing for Windows (ETW) name to be defined independently of the name of the event source class.

public ref class EventSourceAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.Class)]
public sealed class EventSourceAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Class)>]
type EventSourceAttribute = class
    inherit Attribute
Public NotInheritable Class EventSourceAttribute
Inherits Attribute
Inheritance
EventSourceAttribute
Attributes

Remarks

By default, in event tracing for Windows (ETW), the name of an event source matches the name of the event source class, but without the namespace name. This is sufficient for private event sources, but for more visible event sources it is better to have a hierarchical namespace such as: CompanyName.ProviderName. The EventSourceAttribute attribute lets you define the ETW name independently of the name of the class.

The EventSourceAttribute attribute also lets you define a GUID explicitly for the event source. In standard usage, you don't need to specify a GUID when defining an event source or referring to it, because a GUID is implicitly derived from the name of the event source class. Explicitly defining a GUID is discouraged, except when upgrading existing ETW providers to using event sources.

Constructors

EventSourceAttribute()

Initializes a new instance of the EventSourceAttribute class.

Properties

Guid

Gets or sets the event source identifier.

LocalizationResources

Gets or sets the name of the localization resource file.

Name

Gets or sets the name of the event source.

TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode()

Returns the hash code for this instance.

(Inherited from Attribute)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to