MessageQueue.PeekByLookupId メソッド

定義

名前空間:

System.Messaging

アセンブリ:

System.Messaging.dll

MSMQ 3.0 で導入されました。 キュー内の特定のメッセージをピークします。 メッセージは、参照識別子で指定することも、キューの前後の位置関係で指定することもできます。

オーバーロード

PeekByLookupId(Int64)	MSMQ 3.0 で導入されました。 非トランザクション キュー内の指定した参照識別子に一致するメッセージをピークします。
PeekByLookupId(MessageLookupAction, Int64)	MSMQ 3.0 で導入されました。 キュー内の特定のメッセージをピークします。 メッセージは、参照識別子で指定することも、キューの前後の位置関係で指定することもできます。

PeekByLookupId(Int64)

MSMQ 3.0 で導入されました。 非トランザクション キュー内の指定した参照識別子に一致するメッセージをピークします。

public:
 System::Messaging::Message ^ PeekByLookupId(long lookupId);

public System.Messaging.Message PeekByLookupId (long lookupId);

member this.PeekByLookupId : int64 -> System.Messaging.Message

Public Function PeekByLookupId (lookupId As Long) As Message

パラメーター

lookupId

Int64

ピークするメッセージの LookupId。

戻り値

Message

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

例外

PlatformNotSupportedException

MSMQ 3.0 がインストールされていません。

InvalidOperationException

指定した lookupId を持つメッセージは見つかりませんでした。

MessageQueueException

メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。

注釈

このメソッドを使用して、既知の参照識別子を含むメッセージをキューから削除せずに読み取ります。 メッセージがキューにない場合、このメソッドは例外を直ちにスローします。

メッセージの プロパティは LookupId 、メッセージが存在するキューに一意であるため、指定 lookupId されたパラメーターに一致するメッセージがキュー内に最大 1 つ存在します。

指定した参照識別子を持つメッセージを読み取り、キューから削除するには、 メソッドを ReceiveByLookupId 使用します。

次の表は、このメソッドがさまざまなワークグループ モードで使用できるかどうかを示しています。

ワークグループ モード	利用可能
ローカル コンピューター	はい
ローカル コンピューターと直接形式の名前	はい
リモート コンピューター	いいえ
リモート コンピューターと直接形式の名前	はい

こちらもご覧ください

• LookupId
• ReceiveByLookupId

PeekByLookupId(MessageLookupAction, Int64)

MSMQ 3.0 で導入されました。 キュー内の特定のメッセージをピークします。 メッセージは、参照識別子で指定することも、キューの前後の位置関係で指定することもできます。

public:
 System::Messaging::Message ^ PeekByLookupId(System::Messaging::MessageLookupAction action, long lookupId);

public System.Messaging.Message PeekByLookupId (System.Messaging.MessageLookupAction action, long lookupId);

member this.PeekByLookupId : System.Messaging.MessageLookupAction * int64 -> System.Messaging.Message

Public Function PeekByLookupId (action As MessageLookupAction, lookupId As Long) As Message

パラメーター

action

MessageLookupAction

キュー内のメッセージを読み取る方法を指定する MessageLookupAction のいずれか 1 つ。 次のいずれかを指定します。

MessageLookupAction.Current。lookupId で指定されたメッセージをピークします。

MessageLookupAction.Next。lookupId で指定されたメッセージの次のメッセージをピークします。

MessageLookupAction.Previous。lookupId で指定されたメッセージの前のメッセージをピークします。

MessageLookupAction.First: キューの最初のメッセージをピークします。 lookupId パラメーターは、0 に設定する必要があります。

MessageLookupAction.Last: キューの最後のメッセージをピークします。 lookupId パラメーターは、0 に設定する必要があります。

lookupId

Int64

ピークするメッセージの LookupId か、0。 キューの最初または最後のメッセージにアクセスする場合は 0 を使用します。

戻り値

Message

渡された action パラメーターおよび lookupId パラメーターで指定された Message。

例外

PlatformNotSupportedException

MSMQ 3.0 がインストールされていません。

InvalidOperationException

指定した lookupId を持つメッセージは見つかりませんでした。

MessageQueueException

メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。

InvalidEnumArgumentException

action パラメーターが、MessageLookupAction メンバーの 1 つではありません。

注釈

このメソッドを使用して、既知の参照識別子を含むメッセージをキューから削除せずに読み取ります。 メッセージがキューにない場合、このメソッドは例外を直ちにスローします。

メッセージの プロパティは LookupId 、メッセージが存在するキューに一意であるため、指定 lookupId されたパラメーターに一致するメッセージがキュー内に最大 1 つ存在します。

指定した識別子を持つメッセージを読み取り、キューから削除するには、 メソッドを ReceiveByLookupId 使用します。

次の表は、このメソッドがさまざまなワークグループ モードで使用できるかどうかを示しています。

ワークグループ モード	利用可能
ローカル コンピューター	はい
ローカル コンピューターと直接形式の名前	はい
リモート コンピューター	いいえ
リモート コンピューターと直接形式の名前	はい

こちらもご覧ください

• LookupId
• ReceiveByLookupId