ServiceProcessInstaller.Rollback(IDictionary) Method

Definition

Namespace:

System.ServiceProcess

Assembly:

System.ServiceProcess.dll

Rolls back service application information written to the registry by the installation procedure. This method is meant to be used by installation tools, which process the appropriate methods automatically.

public:
 override void Rollback(System::Collections::IDictionary ^ savedState);

public override void Rollback (System.Collections.IDictionary savedState);

override this.Rollback : System.Collections.IDictionary -> unit

Public Overrides Sub Rollback (savedState As IDictionary)

Parameters

savedState

IDictionary

An IDictionary that contains the context information associated with the installation.

Exceptions

ArgumentException

The savedState is null.

-or-

The savedState is corrupted or non-existent.

Remarks

Normally, you do not call the methods on ServiceProcessInstaller within your code; they are generally called only by the install utility. The install utility automatically calls the ServiceProcessInstaller.Install method during the installation process. It backs out failures, if necessary, by calling Rollback on the object that generated the exception.

An application's install routine maintains information automatically about the components already installed, using the project installer's Installer.Context. This state information, passed into Rollback as the savedState parameter, is continuously updated as the ServiceProcessInstaller instance and each ServiceInstaller instance is installed by the utility. It is usually unnecessary for your code to modify this state information explicitly.

Rollback passes to the calling method any exceptions thrown by base class methods or BeforeInstall / AfterInstall event handlers.

See also

• Install(IDictionary)
• ComponentInstaller