Installer.Install(IDictionary) Method

Reference

Definition

Namespace:: System.Configuration.Install

Assembly:: System.Configuration.Install.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

When overridden in a derived class, performs the installation.

public:
 virtual void Install(System::Collections::IDictionary ^ stateSaver);

public virtual void Install (System.Collections.IDictionary stateSaver);

abstract member Install : System.Collections.IDictionary -> unit
override this.Install : System.Collections.IDictionary -> unit

Public Overridable Sub Install (stateSaver As IDictionary)

Parameters

stateSaver: IDictionary

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

Exceptions

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.

Examples

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:
   virtual void Install( IDictionary^ mySavedState ) override
   {
      Installer::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 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 Overrides Sub Install(mySavedState As IDictionary)
   MyBase.Install(mySavedState)
   ' Code maybe written for installation of an application.
   Console.WriteLine("The Install method of 'MyInstallerSample' has been called")
End Sub

Notes to Inheritors

If you override the Install(IDictionary) method in a derived class, be sure to call the base class's Install(IDictionary) method first in your derived method. The Install(IDictionary) method calls the Install(IDictionary) 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(IDictionary) method. If all the Install(IDictionary) methods succeed, the Commit(IDictionary) method is called. Otherwise, the Rollback(IDictionary) method is called.
If you need to add installer instances to the Installers collection in the Install(IDictionary) method, be sure to perform the same additions to the collection in the Uninstall(IDictionary) 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.

Applies to

Share via