EventLogReader EventLogReader EventLogReader EventLogReader Class

Definition

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.

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

Examples

For example code using this class, see How To: Query for Events or How To: Access and Read Event Information.

Constructors

EventLogReader(EventLogQuery) EventLogReader(EventLogQuery) EventLogReader(EventLogQuery) EventLogReader(EventLogQuery)

Initializes a new instance of the EventLogReader class by specifying an event query.

EventLogReader(EventLogQuery, EventBookmark) EventLogReader(EventLogQuery, EventBookmark) EventLogReader(EventLogQuery, EventBookmark) EventLogReader(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.

EventLogReader(String) EventLogReader(String) EventLogReader(String) EventLogReader(String)

Initializes a new instance of the EventLogReader class by specifying an active event log to retrieve events from.

EventLogReader(String, PathType) EventLogReader(String, PathType) EventLogReader(String, PathType) EventLogReader(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.

Properties

BatchSize BatchSize BatchSize BatchSize

Gets or sets the number of events retrieved from the stream of events on every read operation.

LogStatus LogStatus LogStatus LogStatus

Gets the status of each event log or log file associated with the event query in this object.

Methods

CancelReading() CancelReading() CancelReading() CancelReading()

Cancels the current query operation.

Dispose() Dispose() Dispose() Dispose()

Releases all the resources used by this object.

Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

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

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ReadEvent() ReadEvent() ReadEvent() ReadEvent()

Reads the next event that is returned from the event query in this object.

ReadEvent(TimeSpan) ReadEvent(TimeSpan) ReadEvent(TimeSpan) ReadEvent(TimeSpan)

Reads the next event that is returned from the event query in this object.

Seek(EventBookmark) Seek(EventBookmark) Seek(EventBookmark) Seek(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.

Seek(EventBookmark, Int64) Seek(EventBookmark, Int64) Seek(EventBookmark, Int64) Seek(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.

Seek(SeekOrigin, Int64) Seek(SeekOrigin, Int64) Seek(SeekOrigin, Int64) Seek(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.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to