MessageQueue.ReceiveByCorrelationId メソッド (String, MessageQueueTransaction)

指定した相関 ID と一致するメッセージをトランザクション キューから受信します。現在、指定した相関 ID と一致するメッセージがキューに存在しない場合は、すぐに例外を発生させます。

Overloads Public Function ReceiveByCorrelationId( _
   ByVal correlationId As String, _   ByVal transaction As MessageQueueTransaction _) As Message
[C#]
public Message ReceiveByCorrelationId(stringcorrelationId,MessageQueueTransactiontransaction);
[C++]
public: Message* ReceiveByCorrelationId(String* correlationId,MessageQueueTransaction* transaction);
[JScript]
public function ReceiveByCorrelationId(
   correlationId : String,transaction : MessageQueueTransaction) : Message;

パラメータ

• correlationId
  受信するメッセージの CorrelationId 。
• transaction
  MessageQueueTransaction オブジェクト。

戻り値

渡された correlationId パラメータと一致する CorrelationId を持つ Message 。

例外

解説

このメソッドは、 MessageQueue が参照するトランザクション キューで、 CorrelationId が指定した correlationId パラメータと一致するメッセージを検索します。 correlationID パラメータと一致するメッセージが見つからない場合は、例外がスローされます。見つかった場合は、 transaction パラメータで定義された内部トランザクション コンテキストを使用してメッセージがキューから削除され、アプリケーションに返されます。

このメソッドはトランザクション キューで呼び出されるため、トランザクションが中止されると、受信したメッセージがキューに戻されます。メッセージは、トランザクションがコミットされるまで、キューから恒久的に削除されることはありません。

キューに送信したメッセージを、関連付けられている応答、レポート、または受信確認の各メッセージと結び付ける場合は、 CorrelationId プロパティを使用します。

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。 Receive メソッドは、キューの最初のメッセージを返します。一意の ID を指定してメッセージを取得するには、 ReceiveById メソッドを使用します。

指定した相関 ID を持つメッセージをキューから削除せずに読み取るには、 PeekByCorrelationId メソッドを使用します。 PeekByCorrelationId メソッドは、常にキューの最初のメッセージを返します。そのため、より優先順位の高いメッセージがそのキューに到達するまで、後続の呼び出しでも同じメッセージが返されます。 PeekByCorrelationId の呼び出しによって返されるメッセージに関連付けられたトランザクション コンテキストはありません。 PeekByCorrelationId はキューのメッセージを削除しないため、トランザクションが中止されても何もロールバックされません。

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

必要条件

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

.NET Framework セキュリティ:

• 直前の呼び出し元の完全信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細の参照先 : 部分信頼コードからのライブラリの使用

参照

MessageQueue クラス | MessageQueue メンバ | System.Messaging 名前空間 | MessageQueue.ReceiveByCorrelationId オーバーロードの一覧 | MessageQueueTransaction | Transactional | Receive | ReceiveById | Peek | BeginReceive