MessageQueue.ReceiveByLookupId メソッド

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

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

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

Public Function ReceiveByLookupId (lookupId As Long) As Message

パラメーター

戻り値

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

例外

注釈

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

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

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

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

こちらもご覧ください

• LookupId
• PeekByLookupId

public:
 System::Messaging::Message ^ ReceiveByLookupId(System::Messaging::MessageLookupAction action, long lookupId, System::Messaging::MessageQueueTransaction ^ transaction);

public System.Messaging.Message ReceiveByLookupId (System.Messaging.MessageLookupAction action, long lookupId, System.Messaging.MessageQueueTransaction transaction);

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

Public Function ReceiveByLookupId (action As MessageLookupAction, lookupId As Long, transaction As MessageQueueTransaction) As Message

パラメーター

戻り値

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

例外

注釈

このメソッドを使用して、既知の参照識別子を持つメッセージを読み取り、 パラメーターで定義された transaction トランザクション コンテキストを使用してキューから削除します。 メッセージがキューにない場合、このメソッドは例外を直ちにスローします。

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

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

指定した識別子を持つメッセージをキューから削除せずに読み取る場合は、 メソッドを使用します PeekByLookupId 。 への PeekByLookupId呼び出しによって返されるメッセージに関連付けられたトランザクション コンテキストはありません。 はキューからメッセージを削除しないため PeekByLookupId 、トランザクションが中止された場合はロールバックする必要はありません。

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

こちらもご覧ください

• LookupId
• PeekByLookupId

public:
 System::Messaging::Message ^ ReceiveByLookupId(System::Messaging::MessageLookupAction action, long lookupId, System::Messaging::MessageQueueTransactionType transactionType);

public System.Messaging.Message ReceiveByLookupId (System.Messaging.MessageLookupAction action, long lookupId, System.Messaging.MessageQueueTransactionType transactionType);

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

Public Function ReceiveByLookupId (action As MessageLookupAction, lookupId As Long, transactionType As MessageQueueTransactionType) As Message

パラメーター

戻り値

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

例外

注釈

パラメーターで定義されたトランザクション コンテキストを使用して、既知の参照識別子を持つメッセージを読み取り、キューから削除するには、このメソッドを transactionType 使用します。 メッセージがキューにない場合、このメソッドは例外を直ちにスローします。

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

指定した識別子を持つメッセージをキューから削除せずに読み取る場合は、 メソッドを PeekByLookupId 使用します。 への PeekByLookupId呼び出しによって返されるメッセージに関連付けられたトランザクション コンテキストはありません。 はキューからメッセージを削除しないため PeekByLookupId 、トランザクションが中止された場合はロールバックする必要はありません。

メッセージの受信に使用するtransactionTypeスレッドに外部トランザクション コンテキストが既にアタッチされている場合は、 パラメーターに を指定Automaticします。 メッセージを 1 つの内部トランザクションとして受信するかどうかを指定 Single します。 トランザクション コンテキストの外部のトランザクション キューからメッセージを受信するかどうかを指定 None できます。

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

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

こちらもご覧ください

• LookupId
• PeekByLookupId