Install Method

Installer.Install Method (IDictionary)

 

When overridden in a derived class, performs the installation.

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

abstract Install : 
        stateSaver:IDictionary -> unit
override Install : 
        stateSaver:IDictionary -> unit

Parameters

stateSaver
Type: System.Collections.IDictionary

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

Exception Condition
ArgumentException

The stateSaver parameter is null.

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.

No code example is currently available or this language may not be supported.

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