MessageQueue.GetAllMessages メソッド

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

MessageQueue.GetAllMessages メソッド

キューにあるすべてのメッセージを返します。

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

Visual Basic (宣言)

Public Function GetAllMessages As
 Message()

Visual Basic (使用法)

Dim instance As MessageQueue
Dim returnValue As Message()

returnValue = instance.GetAllMessages

C#

public Message[] GetAllMessages ()

C++

public:
array<Message^>^ GetAllMessages ()

J#

public Message[] GetAllMessages ()

JScript

public function GetAllMessages () : Message[]

戻り値
キューにあるすべてのメッセージを表す型 Message の配列。配列の順序は、メッセージがメッセージ キューのキューに存在する順序と同じです。

例外

例外の種類	条件
MessageQueueException	メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。

解説

GetAllMessages は、キューにあるメッセージの静的なスナップショットを返します。メッセージへの動的リンクではありません。そのため、この配列を使用してキューのメッセージは変更できません。キューとリアルタイムに動的な対話 (メッセージの削除など) をするには、キューにあるメッセージの動的リストを返す GetMessageEnumerator2 メソッドを呼び出します。

GetAllMessages は、メソッドが呼び出された時点でキューにあるメッセージのコピーを返すため、キューに到達した新しいメッセージまたはキューから削除されたメッセージは反映されません。

GetAllMessages は、MessageReadPropertyFilter プロパティでフィルタをかけられていないプロパティだけを取得します。

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

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

使用例

GetAllMessages を使用する方法を次のコード例に示します。

C#

// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");

// Populate an array with copies of all the messages in the queue.
Message[] msgs = queue.GetAllMessages();

// Loop through the messages.
foreach(Message msg in msgs)
{
    // Display the label of each message.
    Console.WriteLine(msg.Label);
}

C++

// Connect to a queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");

// Populate an array with copies of all the messages in the queue.
array<Message^>^ msgs = queue->GetAllMessages();

// Loop through the messages.
for each(Message^ msg in msgs)
{
    // Display the label of each message.
    Console::WriteLine(msg->Label);
}

queue->Close();

J#

// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Populate an array with copies of all the messages in the queue.
Message msgs[] = queue.GetAllMessages();
// Loop through the messages.
for (int iCtr = 0; iCtr < msgs.length; iCtr++)
 {
    Message msg = msgs[iCtr];
    // Display the label of each message.
    Console.WriteLine(msg.get_Label());
}

.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 名前空間
Message クラス
GetMessageEnumerator2