Commit Method

Installer::Commit Method (IDictionary^)

 

When overridden in a derived class, completes the install transaction.

Namespace:   System.Configuration.Install
Assembly:  System.Configuration.Install (in System.Configuration.Install.dll)

public:
virtual void Commit(
	IDictionary^ savedState
)

Parameters

savedState
Type: System.Collections::IDictionary^

An IDictionary that contains the state of the computer after all the installers in the collection have run.

Exception Condition
ArgumentException

The savedState parameter is null.

-or-

The saved-state IDictionary might have been corrupted.

InstallException

An exception occurred during the Commit phase of the installation. This exception is ignored and the installation continues. However, the application might not function correctly after the installation is complete.

Notes to Inheritors:

If you override the Commit method in a derived class, be sure to call the base class's Commit method first in your derived method. The Commit method is called only if the Install method of each installer in this instance's InstallerCollection succeeds. The Commit method stores information needed to do a correct uninstallation, and calls the Commit method of each installer in the collection.

The following example demonstrates the Commit method of the Installer class. A class is derived from the Installer base class and the Commit method are overridden.

// Override the 'Commit' method of the Installer class.
virtual void Commit( IDictionary^ mySavedState ) override
{
   Installer::Commit( mySavedState );
   Console::WriteLine( "The Commit method of 'MyInstallerSample' "
      "has been called" );
}

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