This documentation is archived and is not being maintained.

EventLogEntryCollection Class

Defines size and enumerators for a collection of EventLogEntry instances.

Namespace:  System.Diagnostics
Assembly:  System (in System.dll)

'Declaration
Public Class EventLogEntryCollection _
	Implements ICollection, IEnumerable
'Usage
Dim instance As EventLogEntryCollection

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.

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

Imports System
Imports System.Collections
Imports System.Diagnostics

Class EventLogEntryCollection_Item
   Public Shared Sub Main()
      Try 
         Dim myLogName As String = "MyNewlog" 
         ' Check if the source exists. 
         If Not EventLog.SourceExists("MySource") Then 
            'Create source.
            EventLog.CreateEventSource("MySource", myLogName)
            Console.WriteLine("Creating EventSource")
         ' Get the EventLog associated if the source exists. 
         Else
            myLogName = EventLog.LogNameFromSourceName("MySource", ".")
         End If 
         ' Create an EventLog instance and assign its source. 
         Dim myEventLog2 As 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. 
         Dim myEventLog1 As New EventLog()
         myEventLog1.Log = myLogName

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

         ' Display the 'Message' property of EventLogEntry. 
         Dim i As Integer 
         For i = 0 To myEventLogEntryCollection.Count - 1
            Console.WriteLine("The Message of the EventLog is :" + _
                              myEventLogEntryCollection(i).Message)
         Next i
         ' Copy the EventLog entries to Array of type EventLogEntry. 
         Dim myEventLogEntryArray(myEventLogEntryCollection.Count-1) As EventLogEntry
         myEventLogEntryCollection.CopyTo(myEventLogEntryArray, 0)
         Dim myEnumerator As IEnumerator = myEventLogEntryArray.GetEnumerator()
         While myEnumerator.MoveNext()
            Dim myEventLogEntry As EventLogEntry = CType(myEnumerator.Current, EventLogEntry)
            Console.WriteLine("The LocalTime the Event is generated is " + _
                                 myEventLogEntry.TimeGenerated)
         End While 
      Catch e As Exception
         Console.WriteLine("Exception:{0}", e.Message.ToString())
      End Try 
   End Sub 'Main
End Class 'EventLogEntryCollection_Item

System.Object
  System.Diagnostics.EventLogEntryCollection

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

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
Show: