Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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
)
public void Commit (
	IDictionary savedState
)
public function Commit (
	savedState : IDictionary
)
Not applicable.

Parameters

savedState

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

Exception typeCondition

ArgumentException

The savedState parameter is a null reference (Nothing in Visual Basic).

-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" );
}

// Override the 'Commit' method of the Installer class.
public void Commit(IDictionary mySavedState)
{
    super.Commit(mySavedState);
    Console.WriteLine("The Commit method of 'MyInstallerSample'"
        + "has been called");
} //Commit

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.