This documentation is archived and is not being maintained.

EventProvider Class

Use this class to write events.

System.Object
  System.Diagnostics.Eventing.EventProvider

Namespace:  System.Diagnostics.Eventing
Assembly:  System.Core (in System.Core.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, MayLeakOnAbort = true)]
public class EventProvider : IDisposable

The EventProvider type exposes the following members.

  NameDescription
Public methodEventProviderInitializes a new instance of the EventProvider class.
Top

  NameDescription
Public methodCloseRemoves the provider's registration from the ETW subsystem and releases all unmanaged resources.
Public methodStatic memberCreateActivityIdCreates a unique activity identifier for the provider.
Public methodDispose()
Protected methodDispose(Boolean)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Overrides Object.Finalize().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodStatic memberGetLastWriteEventErrorGets the last error associated with an event write failure.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsEnabled()Determines whether any session enabled the provider, regardless of the level and keyword values used to enable the provider.
Public methodIsEnabled(Byte, Int64)Determines whether any session is requesting the specified event from the provider.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic memberSetActivityIdSets the current activity identifier used by the WriteEvent methods.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodWriteEvent(EventDescriptor, Object[])Writes an event. The event data is specified as an array of objects.
Public methodWriteEvent(EventDescriptor, String)Writes an event. The event data is specified as a string.
Protected methodWriteEvent(EventDescriptor, Int32, IntPtr)Infrastructure. Writes an event. The event data is specified as a block of memory.
Public methodWriteMessageEvent(String)Writes an event that contains a string as its data.
Public methodWriteMessageEvent(String, Byte, Int64)Writes an event that contains a string as its data if the level and keyword value match the events requested by the session.
Public methodWriteTransferEvent(EventDescriptor, Guid, Object[])Links events together when tracing events in an end-to-end scenario. The event data is specified as an array of objects.
Protected methodWriteTransferEvent(EventDescriptor, Guid, Int32, IntPtr)Infrastructure. Links events together when tracing events in an end-to-end scenario. The event data is specified as a block of memory.
Top

To consume events written using the WriteEvent and WriteTransferEvent methods, the events must be defined in a manifest; events written using the WriteMessageEvent method do not require a manifest.

Events can contain the following managed data types:

  • bool

  • Boolean

  • byte

  • char

  • decimal

  • double

  • float

  • Guid

  • int

  • IntPtr

  • long

  • sbyte

  • short

  • string

  • uint

  • UInt64

If an event in your manifest uses the Boolean in-type, you cannot write the data element using a Boolean data type in your managed code. The Boolean in-type in your manifest expects a 4-byte value, and a Boolean data type in managed code is 1-byte. Instead, you must use an int data type to write the value. If you want to log a Boolean value, use the UInt8 in-type in your manifest.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: MayLeakOnAbort. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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: