EventLogConfiguration Class

 

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.

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

System.Object
  System.Diagnostics.Eventing.Reader.EventLogConfiguration

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

NameDescription
System_CAPS_pubmethodEventLogConfiguration(String)

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

System_CAPS_pubmethodEventLogConfiguration(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.

NameDescription
System_CAPS_pubpropertyIsClassicLog

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

System_CAPS_pubpropertyIsEnabled

Gets or sets a Boolean value that determines 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.

System_CAPS_pubpropertyLogFilePath

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

System_CAPS_pubpropertyLogIsolation

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

System_CAPS_pubpropertyLogMode

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

System_CAPS_pubpropertyLogName

Gets the name of the event log.

System_CAPS_pubpropertyLogType

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

System_CAPS_pubpropertyMaximumSizeInBytes

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.

System_CAPS_pubpropertyOwningProviderName

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

System_CAPS_pubpropertyProviderBufferSize

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

System_CAPS_pubpropertyProviderControlGuid

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 will be null.

System_CAPS_pubpropertyProviderKeywords

Gets or sets keyword mask used by the event provider.

System_CAPS_pubpropertyProviderLatency

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

System_CAPS_pubpropertyProviderLevel

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.

System_CAPS_pubpropertyProviderMaximumNumberOfBuffers

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

System_CAPS_pubpropertyProviderMinimumNumberOfBuffers

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

System_CAPS_pubpropertyProviderNames

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

System_CAPS_pubpropertySecurityDescriptor

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.

NameDescription
System_CAPS_pubmethodDispose()

Releases all the resources used by this object.

System_CAPS_protmethodDispose(Boolean)

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

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSaveChanges()

Saves the configuration settings that

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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

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

.NET Framework
Available since 3.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

System.Diagnostics.Eventing.Reader Namespace
Technology Summary for Reading and Managing Event Logs
Event Log Scenarios

Return to top
Show: