MessageQueue.FormatName プロパティ

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

MessageQueue.FormatName プロパティ

キューの作成時にメッセージ キューが生成した一意なキュー名を取得します。

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

Visual Basic (宣言)

Public ReadOnly Property
 FormatName As String

Visual Basic (使用法)

Dim instance As MessageQueue
Dim value As String

value = instance.FormatName

C#

public string FormatName { get;
 }

C++

public:
property String^ FormatName {
    String^ get ();
}

J#

/** @property */
public String get_FormatName ()

JScript

public function get FormatName
 () : String

プロパティ値
ネットワークで一意なキューの名前。

例外

例外の種類	条件
MessageQueueException	Path が設定されていません。 または メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。

解説

キューの書式名を格納する FormatName プロパティ。メッセージ キューは書式名を使用して、開くキューとキューへのアクセス方法を識別します。その他のほとんどのキューの特性とは異なり、書式名はメッセージ キュー アプリケーション キュー プロパティではありません。そのため、メッセージ キュー管理ツールではアクセスできません。書式名は単にキューの一意な名前です。キューを作成するときにメッセージ キューが生成するか、後でアプリケーションが生成します。

キューからの読み取りまたはキューへの書き込みを実行するときに、パスの指定に書式名構文ではなく、パス名構文 (myComputer\myQueue など) を使用する場合、Path は、キューにアクセスする前に、(Active Directory を使用する) プライマリ ドメイン コントローラによって、このパスと関連付けられた FormatName に変換されます。アプリケーションをオフラインで実行する場合は、パスの変換を実行するプライマリ ドメイン コントローラが利用できないため、書式名構文を使用する必要があります。

このプロパティが各種のワークグループ モードで使用できるかどうかを次の表に示します。

ワークグループ モード	使用可否
ローカル コンピュータ	○
ローカル コンピュータと直接書式名	○
リモート コンピュータ	○
リモート コンピュータと直接書式名	○

使用例

メッセージ キューの FormatName プロパティの値を表示するコード例を次に示します。

C#

// Display the value of the queue's FormatName property.
Console.WriteLine("MessageQueue.FormatName: {0}", queue.FormatName);

J#

// Display the value of the queue's FormatName property.
Console.WriteLine("MessageQueue.FormatName: {0}", 
    queue.get_FormatName());

.NET Framework のセキュリティ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
MessageQueue クラス
MessageQueue メンバ
System.Messaging 名前空間
Path
Label
MessageQueue クラス