This documentation is archived and is not being maintained.

Installer.OnCommitting Method

Raises the Committing event.

[Visual Basic]
Protected Overridable Sub OnCommitting( _
   ByVal savedState As IDictionary _
protected virtual void OnCommitting(
 IDictionary savedState
protected: virtual void OnCommitting(
 IDictionary* savedState
protected function OnCommitting(
   savedState : IDictionary


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


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 Raising an Event.

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


[Visual Basic, C#, C++] 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.

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

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

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

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.


Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

.NET Framework Security: 

See Also

Installer Class | Installer Members | System.Configuration.Install Namespace | OnAfterInstall | OnAfterRollback | OnAfterUninstall | OnCommitted | OnBeforeInstall | OnBeforeRollback | OnBeforeUninstall