MessageQueueInstaller.Commit Method (IDictionary)

 

Completes the installation process by committing the MessageQueue installation information that the Install method wrote to the registry. This method is meant to be used by installation tools, which automatically call the appropriate methods.

Namespace:   System.Messaging
Assembly:  System.Messaging (in System.Messaging.dll)

public override void Commit(
	IDictionary savedState
)

Parameters

savedState
Type: System.Collections.IDictionary

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

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 Install method during the installation process. Installation is transactional, so if there is a failure of any installation project component during the installation, all the previously installed components are rolled back to their pre-installation states. This is accomplished by calling each component's Rollback method.

After a successful installation of all the components that are associated with the installation project has occurred, the installation utility commits the installations. Commit completes the installation of the MessageQueue by setting the queue to the appropriate initial state. If the queue specified by the Path property already exists and contains messages, Commit clears the messages. Commit, rather than Install, clears the messages because the act of purging the messages cannot be rolled back.

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 Commit as the savedState parameter, is continuously updated as the utility commits each MessageQueueInstaller instance. Usually, it is not necessary for your code to explicitly modify this state information. When the queue has been cleared, Commit posts a log entry to the savedState that is associated with the installation.

.NET Framework
Available since 1.1
Return to top
Show: