Export (0) Print
Expand All

EventLog::DeleteEventSource Method (String, String)

Removes the application's event source registration from the specified computer.

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

public:
static void DeleteEventSource(
	String^ source, 
	String^ machineName
)

Parameters

source
Type: System::String

The name by which the application is registered in the event log system.

machineName
Type: System::String

The name of the computer to remove the registration from, or "." for the local computer.

ExceptionCondition
ArgumentException

The machineName parameter is invalid.

- or -

The source parameter does not exist in the registry of the specified computer.

- or -

You do not have write access on the registry key for the event log.

InvalidOperationException

source cannot be deleted because in the registry, the parent registry key for source does not contain a subkey with the same name.

Use this overload to remove the registration of a Source from a remote computer. DeleteEventSource accesses the registry on the computer specified by machineName and removes the registration of your application as a valid source of events.

You can remove your component as a valid source of events if you no longer need it to write entries to that log. For example, you might do this if you need to change your component from one log to another. Because a source can only be registered to one log at a time, changing the log requires you to remove the current registration.

DeleteEventSource removes only the source registered to a log. If you want to remove the log itself, call Delete. If you only want to delete the log entries, call Clear. Delete and DeleteEventSource are static methods, so they can be called on the class itself. It is not necessary to create an instance of EventLog to call either method.

Deleting a log through a call to Delete automatically deletes the sources registered to that log. This can make other applications using that log inoperative.

NoteNote

If a source has already been mapped to a log and you remap it to a new log, you must restart the computer for the changes to take effect.

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

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.

#using <System.dll>

using namespace System;
using namespace System::Diagnostics;
using namespace System::Threading;
int main()
{
   String^ logName;
   if ( EventLog::SourceExists( "MySource", "MyMachine") )
   {

      // Find the log associated with this source.    
      logName = EventLog::LogNameFromSourceName( "MySource", "MyMachine" );
	  // Make sure the source is in the log we believe it to be in 
      if (logName != "MyLog")
		  return -1;
      // Delete the source and the log.
      EventLog::DeleteEventSource( "MySource", "MyMachine" );
      EventLog::Delete( logName, "MyMachine" );
      Console::WriteLine( "{0} deleted.", logName );
   }
   else
        {
            // Create the event source to make next try successful.
			EventSourceCreationData^ mySourceData = gcnew EventSourceCreationData("MySource", "MyLog");
            mySourceData->MachineName = "MyMachine";
            EventLog::CreateEventSource(mySourceData);
        }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft