Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

MessageQueueInstaller.Install Method

Performs the installation and writes message queue information 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 Install (
	IDictionary stateSaver
)
public void Install (
	IDictionary stateSaver
)
public override function Install (
	stateSaver : IDictionary
)

Parameters

stateSaver

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

The Install method writes message queue information to the registry, and associates the MessageQueue instance with a queue that is located at the path specified by the Path property. If the queue does not already exist, Install creates a transactional queue. Install sets the new or existing queue properties to those that you have specified in the MessageQueueInstaller. If the queue already exists, its properties are reset to those of the MessageQueueInstaller. If the existing queue is not transactional, it is deleted and then recreated as a transactional queue.

Caution noteCaution

If it is necessary to recreate the queue, messages in the queue will be lost.

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 to write registry information that is associated with the message queue being installed. 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 Install as the stateSaver parameter, is continuously updated as the utility installs each MessageQueueInstaller instance. Usually, it is not necessary for your code to explicitly modify this state information.

  • Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see .

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.