Installer.OnCommitted(IDictionary) Method

Reference

Definition

Namespace:: System.Configuration.Install

Assembly:: System.Configuration.Install.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Raises the Committed event.

protected:
 virtual void OnCommitted(System::Collections::IDictionary ^ savedState);

protected virtual void OnCommitted (System.Collections.IDictionary savedState);

abstract member OnCommitted : System.Collections.IDictionary -> unit
override this.OnCommitted : System.Collections.IDictionary -> unit

Protected Overridable Sub OnCommitted (savedState As IDictionary)

Parameters

savedState: IDictionary

An IDictionary that contains the state of the computer after all the installers in the Installers property run.

Examples

The following example demonstrates the OnCommitted method of the Installer class. The OnCommitted method is overridden in the derived class. Space is provided for the user to add the steps to be performed before committing and after committing.

   // Override the 'OnCommitted' method.
protected:
   virtual void OnCommitted( IDictionary^ savedState ) override
   {
      Installer::OnCommitted( savedState );
      
      // Add steps to be done after committing an application.
      Console::WriteLine( "The OnCommitted method of MyInstaller called" );
   }

// Override the 'OnCommitted' method.
protected override void OnCommitted(IDictionary savedState)
{
   base.OnCommitted(savedState);
   // Add steps to be done after committing an application.
   Console.WriteLine("The OnCommitted method of MyInstaller called");
}

' Override the 'OnCommitted' method.
Protected Overrides Sub OnCommitted(savedState As IDictionary)
   MyBase.OnCommitted(savedState)
   ' Add steps to be done after committing an application.
   Console.WriteLine("The OnCommitted method of MyInstaller called")
End Sub

Remarks

This method is called after the Commit methods of all the installers contained in this instance's installer collection run.

Raising an event invokes the event handler through a delegate. For more information, see Handling and Raising Events.

The OnCommitted method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors

When overriding OnCommitted(IDictionary) in a derived class, be sure to call the base class's OnCommitted(IDictionary) method so that registered delegates receive the event.

Applies to

Share via