Installer.Commit Method (System.Configuration.Install)

Commit Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

Public Overridable Sub Commit ( _
    savedState As IDictionary _
)

Visual Basic (Usage)

Dim instance As Installer
Dim savedState As IDictionary

instance.Commit(savedState)

public virtual void Commit(
    IDictionary savedState
)

Visual C++

public:
virtual void Commit(
    IDictionary^ savedState
)

JScript

public function Commit(
    savedState : IDictionary
)

Parameters

savedState: Type: System.Collections..::.IDictionary
An IDictionary that contains the state of the computer after all the installers in the collection have run.

Exceptions

Exception	Condition
ArgumentException	The savedState parameter is nullNothingnullptra 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.

Exception

Condition

ArgumentException

The savedState parameter is nullNothingnullptra 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.

Remarks

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.

Examples

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.

Visual Basic

' Override the 'Commit' method of the Installer class.
Public Overrides Sub Commit(mySavedState As IDictionary)
   MyBase.Commit(mySavedState)
   Console.WriteLine("The Commit method of 'MyInstallerSample'" + _
                                                "has been called")
End Sub 'Commit

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

Visual C++

// 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 Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

Installer Class

Installer Members

System.Configuration.Install Namespace