LogNameFromSourceName Method

EventLog.LogNameFromSourceName Method (String, String)

 

Gets the name of the log to which the specified source is registered.

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

Public Shared Function LogNameFromSourceName (
	source As String,
	machineName As String
) As String

Parameters

source
Type: System.String

The name of the event source.

machineName
Type: System.String

The name of the computer on which to look, or "." for the local computer.

Return Value

Type: System.String

The name of the log associated with the specified source in the registry.

The event source indicates what logs the event. It is often the name of the application, or the name of a subcomponent of the application, if the application is large. Applications and services should write to the Application log or a custom log. Device drivers should write to the System log.

When you create a new source, which can only write to one log at a time, the system registers your application with the event log as a valid source of entries. The Source property can be any string, but the name cannot be used by other sources on the computer. An attempt to create a duplicated Source value throws an exception. However, a single event log can have many different sources writing to it.

The following example deletes a source from the local computer. The example determines the log from its source, and then deletes the log.

System_CAPS_noteNote

More than one source might write to an event log. Before deleting a custom log, make sure there are no other sources writing to that log.

Option Explicit On
Option Strict On

Imports System
Imports System.Diagnostics
Imports System.Threading

Class MySample
    Public Shared Sub Main()
        Dim logName As String

        If EventLog.SourceExists("MySource") Then
            ' Find the log associated with this source.    
            logName = EventLog.LogNameFromSourceName("MySource", ".")
            ' Make sure the source is in the log we believe it to be in
            If (logName <> "MyLog") Then
                Return
            End If
            ' Delete the source and the log.
            EventLog.DeleteEventSource("MySource")
            EventLog.Delete(logName)

            Console.WriteLine((logName & " deleted."))
        Else
            ' Create the event source to make next try successful.
            EventLog.CreateEventSource("MySource", "MyLog")
        End If
    End Sub 'Main
End Class 'MySample

EventLogPermission

for administering event log information on the computer. Associated enumeration: EventLogPermissionAccess.Administer

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft