This documentation is archived and is not being maintained.

EventLogReader Class

Enables you to read events from an event log based on an event query. The events that are read by this object are returned as EventRecord objects.

System::Object
  System.Diagnostics.Eventing.Reader::EventLogReader

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

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

The EventLogReader type exposes the following members.

  NameDescription
Public methodEventLogReader(EventLogQuery)Initializes a new instance of the EventLogReader class by specifying an event query.
Public methodEventLogReader(String)Initializes a new instance of the EventLogReader class by specifying an active event log to retrieve events from.
Public methodEventLogReader(EventLogQuery, EventBookmark)Initializes a new instance of the EventLogReader class by specifying an event query and a bookmark that is used as starting position for the query.
Public methodEventLogReader(String, PathType)Initializes a new instance of the EventLogReader class by specifying the name of an event log to retrieve events from or the path to a log file to retrieve events from.
Top

  NameDescription
Public propertyBatchSizeGets or sets the number of events retrieved from the stream of events on every read operation.
Public propertyLogStatusGets the status of each event log or log file associated with the event query in this object.
Top

  NameDescription
Public methodCancelReadingCancels the current query operation.
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.)
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 methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodReadEvent()Reads the next event that is returned from the event query in this object.
Public methodReadEvent(TimeSpan)Reads the next event that is returned from the event query in this object.
Public methodSeek(EventBookmark)Changes the position in the event stream where the next event that is read will come from by specifying a bookmark event. No events logged before the bookmark event will be retrieved.
Public methodSeek(EventBookmark, Int64)Changes the position in the event stream where the next event that is read will come from by specifying a bookmark event and an offset number of events from the bookmark. No events logged before the bookmark plus the offset will be retrieved.
Public methodSeek(SeekOrigin, Int64)Changes the position in the event stream where the next event that is read will come from by specifying a starting position and an offset from the starting position. No events logged before the starting position plus the offset will be retrieved.
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 | 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: