Installer::Rollback Method (IDictionary^)

.NET Framework (current version)

When overridden in a derived class, restores the pre-installation state of the computer.

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

Syntax

C++

public:
virtual void Rollback(
	IDictionary^ savedState
)

Parameters

savedState: Type: System.Collections::IDictionary^
An IDictionary that contains the pre-installation state of the computer.

Exceptions

Exception	Condition
ArgumentException	The savedState parameter is null. -or- The saved-state IDictionary might have been corrupted.
InstallException	An exception occurred during the Rollback phase of the installation. This exception is ignored and the rollback continues. However, the computer might not be fully reverted to its initial state after the rollback completes.

Notes to Inheritors:

When you override the Rollback method in a derived class, be sure to call the base class's Rollback method first in your derived method. A rollback operation restores the computer to the state it was in before the installations occurred. The Rollback method is called if the Install method of this instance of Installer, or any installer in the installer collection, fail to run correctly. Any exceptions generated by calling the Rollback methods of the installers in the installer collection are ignored and the rollback of the other installers continues.

Examples

The following example demonstrates the Rollback method of Installer. The Rollback method is overridden in the derived class of Installer. An exception is generated to force an installation rollback.

C++

   // Override 'Rollback' method of Installer class.
public:
   virtual void Rollback( IDictionary^ mySavedState ) override
   {
      Installer::Rollback( mySavedState );
      Console::WriteLine( "The Rollback method of 'MyInstallerSample'" +
                         " has been called" );
   }

Version Information

.NET Framework
Available since 1.1