EventLogEntryCollection Class

Definition

Namespace:

System.Diagnostics

Assembly:

System.Diagnostics.EventLog.dll

Source:

EventLogEntryCollection.cs

Defines size and enumerators for a collection of EventLogEntry instances.

C#

public class EventLogEntryCollection : System.Collections.ICollection

Inheritance

Object

EventLogEntryCollection

Implements

ICollection IEnumerable

Examples

The following example demonstrates how to obtain event log information from an EventLogEntryCollection object.

C#

using System;
using System.Collections;
using System.Diagnostics;

class EventLogEntryCollection_Item
{
    public static void Main()
    {
        try
        {
            string myLogName = "MyNewLog";
            // Check if the source exists.
            if (!EventLog.SourceExists("MySource"))
            {
                // Create the source.
                // An event log source should not be created and immediately used.
                // There is a latency time to enable the source, it should be created
                // prior to executing the application that uses the source.
                // Execute this sample a second time to use the new source.
                EventLog.CreateEventSource("MySource", myLogName);
                Console.WriteLine("Creating EventSource");
                Console.WriteLine("Exiting, execute the application a second time to use the source.");
                // The source is created.  Exit the application to allow it to be registered.
                return;
            }
            else
            {
                // Get the EventLog associated if the source exists.
                myLogName = EventLog.LogNameFromSourceName("MySource", ".");
            }

            // Create an EventLog instance and assign its source.
            EventLog myEventLog2 = new EventLog();
            myEventLog2.Source = "MySource";
            // Write an informational entry to the event log.
            myEventLog2.WriteEntry("Successfully created a new Entry in the Log");
            myEventLog2.Close();
            // Create a new EventLog object.
            EventLog myEventLog1 = new EventLog();
            myEventLog1.Log = myLogName;

            // Obtain the Log Entries of "MyNewLog".
            EventLogEntryCollection myEventLogEntryCollection =
               myEventLog1.Entries;
            myEventLog1.Close();
            Console.WriteLine("The number of entries in 'MyNewLog' = "
               + myEventLogEntryCollection.Count);

            // Display the 'Message' property of EventLogEntry.
            for (int i = 0; i < myEventLogEntryCollection.Count; i++)
            {
                Console.WriteLine("The Message of the EventLog is :"
                   + myEventLogEntryCollection[i].Message);
            }

            // Copy the EventLog entries to Array of type EventLogEntry.
            EventLogEntry[] myEventLogEntryArray =
               new EventLogEntry[myEventLogEntryCollection.Count];
            myEventLogEntryCollection.CopyTo(myEventLogEntryArray, 0);
            IEnumerator myEnumerator = myEventLogEntryArray.GetEnumerator();
            while (myEnumerator.MoveNext())
            {
                EventLogEntry myEventLogEntry = (EventLogEntry)myEnumerator.Current;
                Console.WriteLine("The LocalTime the Event is generated is "
                   + myEventLogEntry.TimeGenerated);
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("Exception:{0}", e.Message);
        }
    }
}

Remarks

Use the EventLogEntryCollection class when reading the entries associated with an EventLog instance. The Entries property of the EventLog class is a collection of all the entries in the event log.

Because new entries are appended to the existing list, stepping through the collection enables you to access the entries that were created after you originally created the EventLogEntryCollection. However, after you view the entire list, it is not updated with new entries.

Properties

Count	Gets the number of entries in the event log (that is, the number of elements in the EventLogEntry collection).
Item[Int32]	Gets an entry in the event log, based on an index that starts at 0 (zero).

Methods

CopyTo(EventLogEntry[], Int32)	Copies the elements of the EventLogEntryCollection to an array of EventLogEntry instances, starting at a particular array index.
GetEnumerator()	Supports a simple iteration over the EventLogEntryCollection object.

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	Copies the elements of the collection to an Array, starting at a particular Array index.
ICollection.IsSynchronized	Gets a value that indicates whether access to the EventLogEntryCollection is synchronized (thread-safe).
ICollection.SyncRoot	Gets an object that can be used to synchronize access to the EventLogEntryCollection object.

Extension Methods

Applies to

See also

• EventLog
• Entries