This documentation is archived and is not being maintained.

EventLogSession Class

Used to access the Event Log service on the local computer or a remote computer so you can manage and gather information about the event logs and event providers on the computer.

System::Object
  System.Diagnostics.Eventing.Reader::EventLogSession

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

[HostProtectionAttribute(SecurityAction::LinkDemand, MayLeakOnAbort = true)]
public ref class EventLogSession : IDisposable

The EventLogSession type exposes the following members.

  NameDescription
Public methodEventLogSession()Initializes a new EventLogSession object, establishes a connection with the local Event Log service.
Public methodEventLogSession(String)Initializes a new EventLogSession object, and establishes a connection with the Event Log service on the specified computer. The credentials (user name and password) of the user who calls the method is used for the credentials to access the remote computer.
Public methodEventLogSession(String, String, String, SecureString, SessionAuthentication)Initializes a new EventLogSession object, and establishes a connection with the Event Log service on the specified computer. The specified credentials (user name and password) are used for the credentials to access the remote computer.
Top

  NameDescription
Public propertyStatic memberGlobalSessionGets a static predefined session object that is connected to the Event Log service on the local computer.
Top

  NameDescription
Public methodCancelCurrentOperationsCancels any operations (such as reading an event log or subscribing to an event log) that are currently active for the Event Log service that this session object is connected to.
Public methodClearLog(String)Clears events from the specified event log.
Public methodClearLog(String, String)Clears events from the specified event log, and saves the cleared events to the specified file.
Public methodDispose()Releases all the resources used by this object.
Protected methodDispose(Boolean)Releases the unmanaged resources used by this object, and optionally releases the managed resources.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public methodExportLog(String, PathType, String, String)Exports events into an external log file. The events are stored without the event messages.
Public methodExportLog(String, PathType, String, String, Boolean)Exports events into an external log file. A flag can be set to indicate that the method will continue exporting events even if the specified query fails for some logs. The events are stored without the event messages.
Public methodExportLogAndMessages(String, PathType, String, String)Exports events and their messages into an external log file.
Public methodExportLogAndMessages(String, PathType, String, String, Boolean, CultureInfo)Exports events and their messages into an external log file. A flag can be set to indicate that the method will continue exporting events even if the specified query fails for some logs. The event messages are exported in the specified language.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetLogInformationGets an object that contains runtime information for the specified event log.
Public methodGetLogNamesGets an enumerable collection of all the event log names that are registered with the Event Log service.
Public methodGetProviderNamesGets an enumerable collection of all the event provider names that are registered with the Event Log service. An event provider is an application that publishes events to an event log.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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: