MessageQueueInstaller.Install メソッド

.NET Framework クラス ライブラリ リファレンス

MessageQueueInstaller.Install メソッド

インストールを実行し、レジストリにメッセージ キュー情報を書き込みます。このメソッドは、セットアップ ツールで使用されます。セットアップ ツールは適切なメソッドを自動的に呼び出します。

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Overrides Sub Install
 ( _
    stateSaver As IDictionary _
)

Visual Basic (使用法)

Dim instance As MessageQueueInstaller
Dim stateSaver As IDictionary

instance.Install(stateSaver)

C#

public override void Install (
    IDictionary stateSaver
)

C++

public:
virtual void Install (
    IDictionary^ stateSaver
) override

J#

public void Install (
    IDictionary stateSaver
)

JScript

public override function Install (
    stateSaver : IDictionary
)

パラメータ

stateSaver

コミット、ロールバック、またはアンインストール操作を実行するために必要な情報を保存するために使用する IDictionary。

解説

Install メソッドは、メッセージ キュー情報をレジストリに書き込み、MessageQueue インスタンスを Path プロパティで指定されたパスにあるキューに関連付けます。キューがまだ存在しない場合、Install はトランザクション キューを作成します。Install は、新規または既存のキュー プロパティを MessageQueueInstaller で指定したプロパティの値に設定します。キューが既に存在する場合、キューのプロパティは MessageQueueInstaller の値にリセットされます。既存のキューがトランザクション キューでない場合、既存のキューは削除され、トランザクション キューとして再作成されます。

注意
キューを再作成する必要がある場合、キューのメッセージは失われます。

通常、コードからは MessageQueueInstaller のメソッドを呼び出しません。一般的に、このメソッドを呼び出すのはインストール ユーティリティの installutil.exe だけです。ユーティリティは、インストール プロセス中に自動的に Install メソッドを呼び出して、インストールするメッセージ キューに関連付けられたレジストリ情報を書き込みます。インストールはトランザクションです。そのため、インストール中にインストール プロジェクト コンポーネントのいずれかが失敗した場合は、既にインストールされていたすべてのコンポーネントがインストール前の状態にロールバックされます。ロールバックは、各コンポーネントの Rollback メソッドを呼び出すことによって実行されます。

インストール プロジェクトに関連付けられたすべてのコンポーネントが正常にインストールされた後、インストール ユーティリティはインストールをコミットします。Commit は、キューを適切な初期状態に設定し、MessageQueue のインストールを完了します。Path プロパティで指定したキューが既に存在し、メッセージが含まれている場合は、Commit によってメッセージが削除されます。Install ではなく、Commit がメッセージを削除します。メッセージのパージはロールバックできないためです。

アプリケーションのインストール ルーチンは、プロジェクト インストーラの Installer.Context を使用して、既にインストールされているコンポーネントに関する情報を自動的に認識します。この状態情報は、Install に stateSaver パラメータとして渡され、ユーティリティが各 MessageQueueInstaller インスタンスをインストールするたびに更新されます。通常、コードではこの状態情報を明示的に変更する必要がありません。

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
MessageQueueInstaller クラス
MessageQueueInstaller メンバ
System.Messaging 名前空間
Commit
Rollback
Uninstall
IDictionary