EventLogConfiguration Class

Definition

Contains static information and configuration settings for an event log. Many of the configurations settings were defined by the event provider that created the log.

public ref class EventLogConfiguration : IDisposable
public class EventLogConfiguration : IDisposable
type EventLogConfiguration = class
    interface IDisposable
Public Class EventLogConfiguration
Implements IDisposable
Inheritance
EventLogConfiguration
Implements

Examples

For example code using this class, see How to: Configure and Read Event Log Properties.

Remarks

If a property is changed for this object, call the SaveChanges method to save the changes.

Constructors

EventLogConfiguration(String)

Initializes a new EventLogConfiguration object by specifying the local event log for which to get information and configuration settings.

EventLogConfiguration(String, EventLogSession)

Initializes a new EventLogConfiguration object by specifying the name of the log for which to get information and configuration settings. The log can be on the local computer or a remote computer, based on the event log session specified.

Properties

IsClassicLog

Gets a value that indicates whether the event log is a classic event log. A classic event log is one that has its events defined in an .mc file instead of a manifest (.xml file) used by the event provider.

IsEnabled

Gets or sets a value that indicates whether the event log is enabled or disabled. An enabled log is one in which events can be logged, and a disabled log is one in which events cannot be logged.

LogFilePath

Gets or sets the file directory path to the location of the file where the events are stored for the log.

LogIsolation

Gets an EventLogIsolation value that specifies whether the event log is an application, system, or custom event log.

LogMode

Gets or sets an EventLogMode value that determines how events are handled when the event log becomes full.

LogName

Gets the name of the event log.

LogType

Gets an EventLogType value that determines the type of the event log.

MaximumSizeInBytes

Gets or sets the maximum size, in bytes, that the event log file is allowed to be. When the file reaches this maximum size, it is considered full.

OwningProviderName

Gets the name of the event provider that created this event log.

ProviderBufferSize

Gets the size of the buffer that the event provider uses for publishing events to the log.

ProviderControlGuid

Gets the control globally unique identifier (GUID) for the event log if the log is a debug log. If this log is not a debug log, this value is null.

ProviderKeywords

Gets or sets the keyword mask used by the event provider.

ProviderLatency

Gets the maximum latency time used by the event provider when publishing events to the log.

ProviderLevel

Gets or sets the maximum event level (which defines the severity of the event) that is allowed to be logged in the event log. This value is defined by the event provider.

ProviderMaximumNumberOfBuffers

Gets the maximum number of buffers used by the event provider to publish events to the event log.

ProviderMinimumNumberOfBuffers

Gets the minimum number of buffers used by the event provider to publish events to the event log.

ProviderNames

Gets an enumerable collection of the names of all the event providers that can publish events to this event log.

SecurityDescriptor

Gets or sets the security descriptor of the event log. The security descriptor defines the users and groups of users that can read and write to the event log.

Methods

Dispose()

Releases all the resources used by this object.

Dispose(Boolean)

Releases the unmanaged resources used by this object, and optionally releases the managed resources.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
SaveChanges()

Saves the configuration settings that.

ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also