Edit

MessageQueueInstaller.Rollback(IDictionary) Method

  • Reference

Definition

Namespace:
System.Messaging
Assembly:
System.Messaging.dll

Restores the computer to the state it was in before the installation, by rolling back the queue information that the installation procedure wrote to the registry. This method is meant to be used by installation tools, which automatically call the appropriate methods.

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

A IDictionary that contains the pre-installation state of the computer.

Remarks

The Rollback method undoes the effects of the Install method. Rollback is called if the installation of any component in the installation project fails. The Install method creates or sets the properties for a queue. Rollback either deletes the queue or resets the properties of a pre-existing queue to their pre-installation values.

Typically, you do not call the methods of the MessageQueueInstaller from within your code; they are generally called only by the InstallUtil.exe installation utility. The utility automatically calls the Rollback method after an installation failure to undo any changes that the installation process has already made.

An application's install routine uses the project installer's Installer.Context to automatically maintain information about the components that have already been installed. This state information, which is passed to Rollback as the savedState parameter, is continuously updated as the utility rolls back each MessageQueueInstaller instance. Usually, it is not necessary for your code to explicitly modify this state information.

Applies to

See also