Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Installer.Install Method

When overridden in a derived class, performs the installation.

Namespace: System.Configuration.Install
Assembly: System.Configuration.Install (in system.configuration.install.dll)

public virtual void Install (
	IDictionary stateSaver
)
public void Install (
	IDictionary stateSaver
)
public function Install (
	stateSaver : IDictionary
)
Not applicable.

Parameters

stateSaver

An IDictionary used to save information needed to perform a commit, rollback, or uninstall operation.

Exception typeCondition

ArgumentException

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

Exception

An exception occurred in the BeforeInstall event handler of one of the installers in the collection.

-or-

An exception occurred in the AfterInstall event handler of one of the installers in the collection.

Notes to Inheritors:

  • If you override the Install method in a derived class, be sure to call the base class's Install method first in your derived method. The Install method calls the Install method of each installer contained in the Installers property of this instance. After the contained installers run, this method updates the IDictionary object (specified through the stateSaver parameter) to reflect the status of the installation. The IDictionary should be empty when passed to the Install method. If all the Install methods succeed, the Commit method is called. Otherwise, the Rollback method is called.

  • If you need to add installer instances to the Installers collection in the Install method, be sure to perform the same additions to the collection in the Uninstall method. However, you can avoid maintaining the collection in both methods if you add installer instances to the Installers collection in the class constructor for your custom installer.

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

// Override the 'Install' method of the Installer class.
public override void Install( IDictionary mySavedState )
{
   base.Install( mySavedState );
   // Code maybe written for installation of an application.
   Console.WriteLine( "The Install method of 'MyInstallerSample' has been called" );
}

// Override the 'Install' method of the Installer class.
public void Install(IDictionary mySavedState)
{
    super.Install(mySavedState);

    // Code maybe written for installation of an application.
    Console.WriteLine("The Install method of"
        +" 'MyInstallerSample' has been called");
} //Install

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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft