Installer.OnCommitting(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 Committing event.

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

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

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

Protected Overridable Sub OnCommitting (savedState As IDictionary)

Parameters

savedState: IDictionary

An IDictionary that contains the state of the computer before the installers in the Installers property are committed.

Examples

The following example demonstrates the OnCommitting method of the Installer class. The OnCommitting 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 'OnCommitting' method.
protected:
   virtual void OnCommitting( IDictionary^ savedState ) override
   {
      Installer::OnCommitting( savedState );
      
      // Add steps to be done before committing an application.
      Console::WriteLine( "The OnCommitting method of MyInstaller called" );
   }

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

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

Remarks

This method is called before the Commit methods of the installers in this instance's InstallerCollection run.

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

The OnCommitting 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 OnCommitting(IDictionary) in a derived class, be sure to call the base class's OnCommitting(IDictionary) method so that registered delegates receive the event.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via