Export (0) Print
Expand All

Installer.Commit Method

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.

ExceptionCondition
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. 
public override void Commit( IDictionary mySavedState )
{
   base.Commit( mySavedState );
   Console.WriteLine( "The Commit method of 'MyInstallerSample'"
                     + "has been called" );
}

.NET Framework

Supported in: 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