MessageQueue.ReceiveById メソッド (String, TimeSpan)

指定した ID と一致するメッセージを非トランザクション キューから受信します。指定した ID のメッセージがキューで利用可能になるか、タイムアウトが経過するまで待機します。

Overloads Public Function ReceiveById( _
   ByVal id As String, _   ByVal timeout As TimeSpan _) As Message
[C#]
public Message ReceiveById(stringid,TimeSpantimeout);
[C++]
public: Message* ReceiveById(String* id,TimeSpantimeout);
[JScript]
public function ReceiveById(
   id : String,timeout : TimeSpan) : Message;

パラメータ

• id
  受信するメッセージの Id 。
• timeout
  新しいメッセージを検査できるようになるまでの待機時間を示す TimeSpan 。

戻り値

渡された id パラメータと一致する Id プロパティを持つ Message 。

例外

解説

このメソッドを使用して、既知の識別子の付いたメッセージを読み取り、キューから削除します。 id パラメータで指定されている ID のメッセージがキューにある場合、このメソッドからすぐに制御が戻ります。それ以外の場合、メソッドはメッセージが到達するまで、指定した時間待機します。タイムアウトが発生する前にメッセージが到達しないと、例外がスローされます。

メッセージの Id プロパティは、メッセージ キュー エンタープライズを通じて一意です。そのため、指定された id パラメータと一致するメッセージは、キューに 1 つしか存在しません。

キューにメッセージが到達するまで待機する間、現在のスレッドがブロックされてもよい場合は、 ReceiveById のこのオーバーロードを使用します。スレッドは特定の期間、または timeout パラメータの InfiniteTimeout 値を指定した場合は無期限に、ブロックされます。

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。 Receive メソッドは、キューの最初のメッセージを返します。メッセージがキューに送信されたときに作成された受信確認メッセージ、レポート メッセージ、アプリケーションが生成した応答メッセージを取得するには、 ReceiveByCorrelationId メソッドを使用します。

指定した識別子を持つメッセージをキューから削除せずに読み取るには、 PeekById メソッドを使用します。 PeekById メソッドは、常にキューの最初のメッセージを返します。そのため、より優先順位の高いメッセージがそのキューに到達するまで、後続の呼び出しでも同じメッセージが返されます。

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

必要条件

プラットフォーム: 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.ReceiveById オーバーロードの一覧 | InfiniteTimeout | Receive | ReceiveByCorrelationId | Peek | BeginReceive