MessageQueue.ReceiveByCorrelationId MessageQueue.ReceiveByCorrelationId MessageQueue.ReceiveByCorrelationId MessageQueue.ReceiveByCorrelationId Method

定義

指定した相関 ID と一致するメッセージを受信します。Receives a message that matches a given correlation identifier.

オーバーロード

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)

指定した相関 ID と一致するメッセージを受信します。指定した相関 ID のメッセージがキューで利用可能になるか、タイムアウトの時間が経過するまで待機します。Receives the message that matches the given correlation identifier and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)

指定した相関 ID と一致するメッセージを (トランザクション キューから) 受信します。指定した相関 ID のメッセージがキューで利用可能になるか、タイムアウトの時間が経過するまで待機します。Receives the message that matches the given correlation identifier (from a transactional queue) and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

ReceiveByCorrelationId(String, TimeSpan) ReceiveByCorrelationId(String, TimeSpan) ReceiveByCorrelationId(String, TimeSpan) ReceiveByCorrelationId(String, TimeSpan)

指定した相関 ID と一致するメッセージを (非トランザクション キューから) 受信します。指定した相関 ID のメッセージがキューで利用可能になるか、タイムアウトの時間が経過するまで待機します。Receives the message that matches the given correlation identifier (from a non-transactional queue) and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

ReceiveByCorrelationId(String, MessageQueueTransactionType) ReceiveByCorrelationId(String, MessageQueueTransactionType) ReceiveByCorrelationId(String, MessageQueueTransactionType) ReceiveByCorrelationId(String, MessageQueueTransactionType)

指定した相関 ID と一致するメッセージを受信します。現在、指定した相関 ID と一致するメッセージがキューに存在しない場合は、すぐに例外を発生させます。Receives the message that matches the given correlation identifier and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue.

ReceiveByCorrelationId(String, MessageQueueTransaction) ReceiveByCorrelationId(String, MessageQueueTransaction) ReceiveByCorrelationId(String, MessageQueueTransaction) ReceiveByCorrelationId(String, MessageQueueTransaction)

指定した相関 ID と一致するメッセージを (トランザクション キューから) 受信します。現在、指定した相関 ID と一致するメッセージがキューに存在しない場合は、すぐに例外を発生させます。Receives the message that matches the given correlation identifier (from a transactional queue) and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue.

ReceiveByCorrelationId(String) ReceiveByCorrelationId(String) ReceiveByCorrelationId(String) ReceiveByCorrelationId(String)

指定した相関 ID と一致するメッセージを (非トランザクション キューから) 受信します。現在、指定した相関 ID と一致するメッセージがキューに存在しない場合は、すぐに例外を発生させます。Receives the message that matches the given correlation identifier (from a non-transactional queue) and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue.

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)

指定した相関 ID と一致するメッセージを受信します。指定した相関 ID のメッセージがキューで利用可能になるか、タイムアウトの時間が経過するまで待機します。Receives the message that matches the given correlation identifier and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message ReceiveByCorrelationId (string correlationId, TimeSpan timeout, System.Messaging.MessageQueueTransactionType transactionType);
member this.ReceiveByCorrelationId : string * TimeSpan * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan, transactionType As MessageQueueTransactionType) As Message

パラメーター

correlationId
String String String String

受信するメッセージの CorrelationIdThe CorrelationId of the message to receive.

timeout
TimeSpan TimeSpan TimeSpan TimeSpan

新しいメッセージを検査できるようになるまでの待機時間を示す TimeSpanA TimeSpan that indicates the time to wait until a new message is available for inspection.

transactionType
MessageQueueTransactionType MessageQueueTransactionType MessageQueueTransactionType MessageQueueTransactionType

メッセージと関連付けるトランザクション コンテキストの種類を示す、MessageQueueTransactionType 値の 1 つ。One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

戻り値

渡された correlationId パラメーターと一致する CorrelationId を持つ MessageThe Message whose CorrelationId matches the correlationId parameter passed in.

例外

correlationId パラメーターが null です。The correlationId parameter is null.

指定した correlationId を持つメッセージは見つかりませんでした。The message with the specified correlationId could not be found.

timeout パラメーターに指定した値が無効です。timeoutZero よりも小さいか、InfiniteTimeout よりも大きい可能性があります。The value specified for the timeout parameter is not valid, possibly timeout is less than Zero or greater than InfiniteTimeout.

transactionType パラメーターが、MessageQueueTransactionType メンバーの 1 つではありません。The transactionType parameter is not one of the MessageQueueTransactionType members.

指定した correlationId を持つメッセージがキューに存在せず、タイムアウトが経過する前にキューに到達することもありませんでした。The message with the specified correlationId does not exist in the queue and did not arrive before the time-out expired.

または-or- メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。An error occurred when accessing a Message Queuing method.

次のコード例は、ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType) の使用方法を示します。The following code example demonstrates the use of ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType).


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

// Create a new message.
Message^ msg = gcnew Message("Example Message Body");

// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;

// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType::Single);

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;

// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id,
    TimeSpan::FromSeconds(10.0), MessageQueueTransactionType::Single);

// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
    responseMsg->CorrelationId);

transQueue->Close();
queue->Close();


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

// Create a new message.
Message msg = new Message("Example Message Body");

// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;

// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType.Single);

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;

// Receive the response message from the transactional queue.
responseMsg = transQueue.ReceiveByCorrelationId(id,
    TimeSpan.FromSeconds(10.0), MessageQueueTransactionType.Single);

// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
    responseMsg.CorrelationId);

注釈

このメソッドで参照されるキューは、MessageQueueメッセージがCorrelationId、指定された一致correlationIdパラメーター。This method looks in the queue referenced by the MessageQueue for a message whose CorrelationId matches the specified correlationId parameter. このメソッドは、相関 id を持つメッセージがで指定されたかどうかを返しますすぐに、correlationIdで定義されたトランザクションのコンテキストを使用して、キュー内のパラメーターは、transactionTypeパラメーター。This method returns immediately if the message with the correlation identifier specified by the correlationId parameter is in the queue, using a transaction context defined by the transactionType parameter. それ以外の場合、メソッドは、新しいメッセージが到着する時間の指定された期間を待機します。Otherwise, the method waits the given period of time for a new message to arrive. タイムアウトの有効期限が切れる前に、新しいメッセージが到達しませんが、例外がスローされます。If a new message does not arrive before the time-out expires, an exception is thrown.

timeoutパラメーターでこのメソッドの実行時間の合計が指定されていません。The timeout parameter does not specify the total running time for this method. 代わりに、新しいメッセージがキューに到達するまで待機する時間を指定します。Rather, it specifies the time to wait for a new message to arrive in the queue. 新しいメッセージが到着するたびに、このメソッドは、検査、CorrelationIdと一致している新しいメッセージのcorrelationIdパラメーター。Each time a new message arrives, this method examines the CorrelationId of the new message to see if it matches the correlationId parameter. されていない場合、このメソッドは、経由でタイムアウト期間を開始し、もう 1 つの新しいメッセージが到着するを待ちます。If not, this method starts the time-out period over and waits for another new message to arrive. そのため、タイムアウト期間内に到着する新しいメッセージが引き続き、あるせず、新しいメッセージが到着すると、タイムアウト期間が経過するまで、またはそのメッセージが到着するまで無期限に実行を続行するには、このメソッドの考えられるCorrelationId一致する、correlationIdパラメーター。Therefore, if new messages continue to arrive within the time-out period, it is possible for this method to continue running indefinitely, either until the time-out period expires without any new messages arriving, or until a message arrives whose CorrelationId matches the correlationId parameter. 指定AutomatictransactionType外部トランザクション コンテキストが既に存在する場合は、パラメーターを使用してメッセージを受信する必要のあるスレッドにアタッチされています。Specify Automatic for the transactionType parameter if there is already an external transaction context attached to the thread that you want to use to receive the message. 指定Singleとして 1 つの内部トランザクション メッセージを受信したい場合。Specify Single if you want to receive the message as a single internal transaction. 指定できるNoneトランザクション コンテキストの外でトランザクション キューからメッセージを受信する場合。You can specify None if you want to receive a message from a transactional queue outside of a transaction context.

トランザクション キューからメッセージを受信するこのメソッドが呼び出されると、受信したメッセージが返されます、キューにトランザクションが中止された場合。If this method is called to receive a message from a transactional queue, the message that is received would be returned to the queue if the transaction is aborted. メッセージは完全に削除されません、キューから、トランザクションがコミットされるまで。The message is not permanently removed from the queue until the transaction is committed.

CorrelationIdに関連する応答、レポート、または受信確認メッセージをキューに送信されるメッセージを関連付けるプロパティを使用します。The CorrelationId property is used to tie a message sent to the queue to associated response, report, or acknowledgment messages.

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。Two other methods allow you to receive messages from a queue. Receiveメソッドは、キュー内の最初のメッセージを返します、ReceiveById(String)メソッドを使用して、その一意の識別子を指定することで、メッセージを取得します。The Receive method returns the first message in the queue, and the ReceiveById(String) method is used to retrieve a message by specifying its unique identifier.

キューから削除せずに指定した相関 id のメッセージを読み取り、使用、PeekByCorrelationId(String)メソッド。To read a message with a specified correlation identifier without removing it from the queue, use the PeekByCorrelationId(String) method. PeekByCorrelationId(String)メソッドがメソッドに対する後続の呼び出しより高い優先度のメッセージがキューに到着しない限り、同じメッセージが返されるように、キューで最初のメッセージが常を返します。The PeekByCorrelationId(String) method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue. 呼び出しによって返されるメッセージに関連付けられたトランザクション コンテキストがないPeekByCorrelationId(String)します。There is no transaction context associated with a message returned by a call to PeekByCorrelationId(String). PeekByCorrelationId(String)キューにメッセージは削除されませんがあるトランザクションが中止された場合はロールバックするものがありません。Because PeekByCorrelationId(String) does not remove any messages in the queue, there would be nothing to roll back if the transaction were aborted.

次の表では、このメソッドは、さまざまなワークグループ モードで使用するかどうかを示します。The following table shows whether this method is available in various Workgroup modes.

ワークグループ モードWorkgroup mode 使用可能Available
ローカル コンピューターLocal computer はいYes
ローカル コンピューターと直接形式名Local computer and direct format name はいYes
リモート コンピューターRemote computer いいえNo
リモート コンピューターと直接形式名Remote computer and direct format name はいYes
こちらもご覧ください

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)

指定した相関 ID と一致するメッセージを (トランザクション キューから) 受信します。指定した相関 ID のメッセージがキューで利用可能になるか、タイムアウトの時間が経過するまで待機します。Receives the message that matches the given correlation identifier (from a transactional queue) and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message ReceiveByCorrelationId (string correlationId, TimeSpan timeout, System.Messaging.MessageQueueTransaction transaction);
member this.ReceiveByCorrelationId : string * TimeSpan * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan, transaction As MessageQueueTransaction) As Message

パラメーター

correlationId
String String String String

受信するメッセージの CorrelationIdThe CorrelationId of the message to receive.

timeout
TimeSpan TimeSpan TimeSpan TimeSpan

新しいメッセージを検査できるようになるまでの待機時間を示す TimeSpanA TimeSpan that indicates the time to wait until a new message is available for inspection.

戻り値

渡された correlationId パラメーターと一致する CorrelationId を持つ MessageThe Message whose CorrelationId matches the correlationId parameter passed in.

例外

correlationId パラメーターが null です。The correlationId parameter is null.

または-or- transaction パラメーターが null です。The transaction parameter is null.

timeout パラメーターに指定した値が無効です。timeoutZero よりも小さいか、InfiniteTimeout よりも大きい可能性があります。The value specified for the timeout parameter is not valid, possibly timeout is less than Zero or greater than InfiniteTimeout.

指定した correlationId を持つメッセージがキューに存在せず、タイムアウトが経過する前にキューに到達することもありませんでした。The message with the specified correlationId does not exist in the queue and did not arrive before the time-out expired.

または-or- キューが非トランザクション キューです。The queue is non-transactional.

または-or- メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。An error occurred when accessing a Message Queuing method.

次のコード例は、ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction) の使用方法を示します。The following code example demonstrates the use of ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction).


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

// Create a new message.
Message^ msg = gcnew Message("Example Message Body");

// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;

// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType::Single);

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;

// Create a message queuing transaction.
MessageQueueTransaction^ transaction = gcnew MessageQueueTransaction();

try
{
    // Begin a transaction.
    transaction->Begin();

    // Receive the response message from the transactional queue.
    responseMsg = transQueue->ReceiveByCorrelationId(id,
        TimeSpan::FromSeconds(10.0), transaction);

    // Commit the transaction.
    transaction->Commit();
}
catch (Exception^ ex)
{
    // Cancel the transaction.
    transaction->Abort();

    // Propagate the exception.
    throw ex;
}
finally
{
    // Dispose of the transaction object.
    delete transaction;
    transQueue->Close();
    queue->Close();
}

// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
    responseMsg->CorrelationId);
                   	

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

// Create a new message.
Message msg = new Message("Example Message Body");

// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;

// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType.Single);

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;

// Create a message queuing transaction.
MessageQueueTransaction transaction = new MessageQueueTransaction();

try
{
    // Begin a transaction.
    transaction.Begin();

    // Receive the response message from the transactional queue.
    responseMsg = transQueue.ReceiveByCorrelationId(id,
        TimeSpan.FromSeconds(10.0), transaction);

    // Commit the transaction.
    transaction.Commit();
}
catch(System.Exception e)
{
    // Cancel the transaction.
    transaction.Abort();

    // Propagate the exception.
    throw e;
}
finally
{
    // Dispose of the transaction object.
    transaction.Dispose();
}

// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
    responseMsg.CorrelationId);

注釈

このメソッドで参照されるトランザクション キューは、MessageQueueメッセージがCorrelationId、指定された一致correlationIdパラメーター。This method looks in the transactional queue referenced by the MessageQueue for a message whose CorrelationId matches the specified correlationId parameter. このメソッドは、相関 id を持つメッセージがで指定されたかどうかを返しますすぐに、correlationIdで定義された内部トランザクション コンテキストを使用して、キュー内のパラメーターは、transactionパラメーター。This method returns immediately if the message with the correlation identifier specified by the correlationId parameter is in the queue, using the internal transaction context defined by the transaction parameter. それ以外の場合、メソッドは、新しいメッセージが到着する時間の指定された期間を待機します。Otherwise, the method waits the given period of time for a new message to arrive. タイムアウトの有効期限が切れる前に、新しいメッセージが到達しませんが、例外がスローされます。If a new message does not arrive before the time-out expires, an exception is thrown.

timeoutパラメーターでこのメソッドの実行時間の合計が指定されていません。The timeout parameter does not specify the total running time for this method. 代わりに、新しいメッセージがキューに到達するまで待機する時間を指定します。Rather, it specifies the time to wait for a new message to arrive in the queue. 新しいメッセージが到着するたびに、このメソッドは、検査、CorrelationIdと一致している新しいメッセージのcorrelationIdパラメーター。Each time a new message arrives, this method examines the CorrelationId of the new message to see if it matches the correlationId parameter. されていない場合、このメソッドは、経由でタイムアウト期間を開始し、もう 1 つの新しいメッセージが到着するを待ちます。If not, this method starts the time-out period over and waits for another new message to arrive. そのため、タイムアウト期間内に到着する新しいメッセージが引き続き、あるせず、新しいメッセージが到着すると、タイムアウト期間が経過するまで、またはそのメッセージが到着するまで無期限に実行を続行するには、このメソッドの考えられるCorrelationId一致する、correlationIdパラメーター。Therefore, if new messages continue to arrive within the time-out period, it is possible for this method to continue running indefinitely, either until the time-out period expires without any new messages arriving, or until a message arrives whose CorrelationId matches the correlationId parameter.

トランザクション キューでこのメソッドを呼び出したため、受信したメッセージが返されます、キューにトランザクションが中止された場合。Because this method is called on a transactional queue, the message that is received would be returned to the queue if the transaction is aborted. メッセージは完全に削除されません、キューから、トランザクションがコミットされるまで。The message is not permanently removed from the queue until the transaction is committed.

CorrelationIdに関連する応答、レポート、または受信確認メッセージをキューに送信されるメッセージを関連付けるプロパティを使用します。The CorrelationId property is used to tie a message sent to the queue to associated response, report, or acknowledgment messages.

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。Two other methods allow you to receive messages from a queue. Receiveメソッドは、キュー内の最初のメッセージを返します、ReceiveById(String)メソッドを使用して、その一意の識別子を指定することで、メッセージを取得します。The Receive method returns the first message in the queue, and the ReceiveById(String) method is used to retrieve a message by specifying its unique identifier.

キューから削除せずに指定した相関 id のメッセージを読み取り、使用、PeekByCorrelationId(String)メソッド。To read a message with a specified correlation identifier without removing it from the queue, use the PeekByCorrelationId(String) method. PeekByCorrelationId(String)メソッドがメソッドに対する後続の呼び出しより高い優先度のメッセージがキューに到着しない限り、同じメッセージが返されるように、キューで最初のメッセージが常を返します。The PeekByCorrelationId(String) method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue. 呼び出しによって返されるメッセージに関連付けられたトランザクション コンテキストがないPeekByCorrelationId(String)します。There is no transaction context associated with a message returned by a call to PeekByCorrelationId(String). PeekByCorrelationId(String)キューにメッセージは削除されませんがあるトランザクションが中止された場合はロールバックするものがありません。Because PeekByCorrelationId(String) does not remove any messages in the queue, there would be nothing to roll back if the transaction were aborted.

次の表では、このメソッドは、さまざまなワークグループ モードで使用するかどうかを示します。The following table shows whether this method is available in various Workgroup modes.

ワークグループ モードWorkgroup mode 使用可能Available
ローカル コンピューターLocal computer はいYes
ローカル コンピューターと直接形式名Local computer and direct format name はいYes
リモート コンピューターRemote computer いいえNo
リモート コンピューターと直接形式名Remote computer and direct format name はいYes
こちらもご覧ください

ReceiveByCorrelationId(String, TimeSpan) ReceiveByCorrelationId(String, TimeSpan) ReceiveByCorrelationId(String, TimeSpan) ReceiveByCorrelationId(String, TimeSpan)

指定した相関 ID と一致するメッセージを (非トランザクション キューから) 受信します。指定した相関 ID のメッセージがキューで利用可能になるか、タイムアウトの時間が経過するまで待機します。Receives the message that matches the given correlation identifier (from a non-transactional queue) and waits until either a message with the specified correlation identifier is available in the queue, or the time-out expires.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, TimeSpan timeout);
public System.Messaging.Message ReceiveByCorrelationId (string correlationId, TimeSpan timeout);
member this.ReceiveByCorrelationId : string * TimeSpan -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, timeout As TimeSpan) As Message

パラメーター

correlationId
String String String String

受信するメッセージの CorrelationIdThe CorrelationId of the message to receive.

timeout
TimeSpan TimeSpan TimeSpan TimeSpan

新しいメッセージを検査できるようになるまでの待機時間を示す TimeSpanA TimeSpan that indicates the time to wait until a new message is available for inspection.

戻り値

渡された correlationId パラメーターと一致する CorrelationId を持つ MessageThe Message whose CorrelationId matches the correlationId parameter passed in.

例外

correlationId パラメーターが null です。The correlationId parameter is null.

timeout パラメーターに指定した値が無効です。timeoutZero よりも小さいか、InfiniteTimeout よりも大きい可能性があります。The value specified for the timeout parameter is not valid, possibly timeout is less than Zero or greater than InfiniteTimeout.

指定した correlationId を持つメッセージがキューに存在せず、タイムアウトが経過する前にキューに到達することもありませんでした。The message with the specified correlationId does not exist in the queue and did not arrive before the time-out expired.

または-or- メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。An error occurred when accessing a Message Queuing method.

次のコード例は、ReceiveByCorrelationId(String, TimeSpan) の使用方法を示します。The following code example demonstrates the use of ReceiveByCorrelationId(String, TimeSpan).


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

// Create a new message.
Message^ msg = gcnew Message("Example Message Body");

// Designate a queue to receive the acknowledgement message for this
// message.
msg->AdministrationQueue = 
    gcnew MessageQueue(".\\exampleAdminQueue");

// Set the message to generate an acknowledgement message upon its
// arrival.
msg->AcknowledgeType = AcknowledgeTypes::PositiveArrival;

// Send the message.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

// Receive the message from the queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));

// Connect to the admin queue.
MessageQueue^ adminQueue = 
    gcnew MessageQueue(".\\exampleAdminQueue");

// Set the admin queue's MessageReadPropertyFilter property to ensure
// that the acknowledgement message includes the desired properties.
adminQueue->MessageReadPropertyFilter->Acknowledgment = true;
adminQueue->MessageReadPropertyFilter->CorrelationId = true;

// Receive the acknowledgement message from the admin queue.
Message^ ackMsg = adminQueue->ReceiveByCorrelationId(id,
    TimeSpan::FromSeconds(10.0));

// Display the acknowledgement message's property values.
Console::WriteLine("Message.Label: {0}", ackMsg->Label);
Console::WriteLine("Message.Acknowledgment: {0}",
    ackMsg->Acknowledgment);
Console::WriteLine("Message.CorrelationId: {0}", ackMsg->CorrelationId);

adminQueue->Close();
queue->Close();


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

// Create a new message.
Message msg = new Message("Example Message Body");

// Designate a queue to receive the acknowledgement message for this
// message.
msg.AdministrationQueue = new MessageQueue(".\\exampleAdminQueue");

// Set the message to generate an acknowledgement message upon its
// arrival.
msg.AcknowledgeType = AcknowledgeTypes.PositiveArrival;

// Send the message.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Receive the message from the queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));

// Connect to the admin queue.
MessageQueue adminQueue = new MessageQueue(".\\exampleAdminQueue");

// Set the admin queue's MessageReadPropertyFilter property to ensure
// that the acknowledgement message includes the desired properties.
adminQueue.MessageReadPropertyFilter.Acknowledgment = true;
adminQueue.MessageReadPropertyFilter.CorrelationId = true;

// Receive the acknowledgement message from the admin queue.
Message ackMsg = adminQueue.ReceiveByCorrelationId(id,
    TimeSpan.FromSeconds(10.0));

// Display the acknowledgement message's property values.
Console.WriteLine("Message.Label: {0}", ackMsg.Label);
Console.WriteLine("Message.Acknowledgment: {0}", ackMsg.Acknowledgment);
Console.WriteLine("Message.CorrelationId: {0}", ackMsg.CorrelationId);

注釈

このメソッドで参照される非トランザクション キューは、MessageQueueメッセージがCorrelationId、指定された一致correlationIdパラメーター。This method looks in the non-transactional queue referenced by the MessageQueue for a message whose CorrelationId matches the specified correlationId parameter. このメソッドは、相関 id を持つメッセージがで指定されたかどうかを返しますすぐに、correlationIdパラメーターが、キュー内にします。This method returns immediately if the message with the correlation identifier specified by the correlationId parameter is in the queue. それ以外の場合、メソッドは、新しいメッセージが到着する時間の指定された期間を待機します。Otherwise, the method waits the given period of time for a new message to arrive. タイムアウトの有効期限が切れる前に、新しいメッセージが到達しませんが、例外がスローされます。If a new message does not arrive before the time-out expires, an exception is thrown.

timeoutパラメーターでこのメソッドの実行時間の合計が指定されていません。The timeout parameter does not specify the total running time for this method. 代わりに、新しいメッセージがキューに到達するまで待機する時間を指定します。Rather, it specifies the time to wait for a new message to arrive in the queue. 新しいメッセージが到着するたびに、このメソッドは、検査、CorrelationIdと一致している新しいメッセージのcorrelationIdパラメーター。Each time a new message arrives, this method examines the CorrelationId of the new message to see if it matches the correlationId parameter. されていない場合、このメソッドは、経由でタイムアウト期間を開始し、もう 1 つの新しいメッセージが到着するを待ちます。If not, this method starts the time-out period over and waits for another new message to arrive. そのため、タイムアウト期間内に到着する新しいメッセージが引き続き、あるせず、新しいメッセージが到着すると、タイムアウト期間が経過するまで、またはそのメッセージが到着するまで無期限に実行を続行するには、このメソッドの考えられるCorrelationId一致する、correlationIdパラメーター。Therefore, if new messages continue to arrive within the time-out period, it is possible for this method to continue running indefinitely, either until the time-out period expires without any new messages arriving, or until a message arrives whose CorrelationId matches the correlationId parameter.

CorrelationIdに関連する応答、レポート、または受信確認メッセージをキューに送信されるメッセージを関連付けるプロパティを使用します。The CorrelationId property is used to tie a message sent to the queue to associated response, report, or acknowledgment messages.

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。Two other methods allow you to receive messages from a queue. Receiveメソッドは、キュー内の最初のメッセージを返します、ReceiveById(String)メソッドを使用して、その一意の識別子を指定することで、メッセージを取得します。The Receive method returns the first message in the queue, and the ReceiveById(String) method is used to retrieve a message by specifying its unique identifier.

キューから削除せずに指定した相関 id のメッセージを読み取り、使用、PeekByCorrelationId(String)メソッド。To read a message with a specified correlation identifier without removing it from the queue, use the PeekByCorrelationId(String) method. PeekByCorrelationId(String)メソッドがメソッドに対する後続の呼び出しより高い優先度のメッセージがキューに到着しない限り、同じメッセージが返されるように、キューで最初のメッセージが常を返します。The PeekByCorrelationId(String) method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue.

次の表では、このメソッドは、さまざまなワークグループ モードで使用するかどうかを示します。The following table shows whether this method is available in various Workgroup modes.

ワークグループ モードWorkgroup mode 使用可能Available
ローカル コンピューターLocal computer はいYes
ローカル コンピューターと直接形式名Local computer and direct format name はいYes
リモート コンピューターRemote computer いいえNo
リモート コンピューターと直接形式名Remote computer and direct format name はいYes
こちらもご覧ください

ReceiveByCorrelationId(String, MessageQueueTransactionType) ReceiveByCorrelationId(String, MessageQueueTransactionType) ReceiveByCorrelationId(String, MessageQueueTransactionType) ReceiveByCorrelationId(String, MessageQueueTransactionType)

指定した相関 ID と一致するメッセージを受信します。現在、指定した相関 ID と一致するメッセージがキューに存在しない場合は、すぐに例外を発生させます。Receives the message that matches the given correlation identifier and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, System::Messaging::MessageQueueTransactionType transactionType);
public System.Messaging.Message ReceiveByCorrelationId (string correlationId, System.Messaging.MessageQueueTransactionType transactionType);
member this.ReceiveByCorrelationId : string * System.Messaging.MessageQueueTransactionType -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, transactionType As MessageQueueTransactionType) As Message

パラメーター

correlationId
String String String String

受信するメッセージの CorrelationIdThe CorrelationId of the message to receive.

transactionType
MessageQueueTransactionType MessageQueueTransactionType MessageQueueTransactionType MessageQueueTransactionType

メッセージと関連付けるトランザクション コンテキストの種類を示す、MessageQueueTransactionType 値の 1 つ。One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

戻り値

渡された correlationId パラメーターと一致する CorrelationId を持つ MessageThe Message whose CorrelationId matches the correlationId parameter passed in.

例外

correlationId パラメーターが null です。The correlationId parameter is null.

指定した correlationId を持つメッセージは見つかりませんでした。The message with the specified correlationId could not be found.

transactionType パラメーターが、MessageQueueTransactionType メンバーの 1 つではありません。The transactionType parameter is not one of the MessageQueueTransactionType members.

メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。An error occurred when accessing a Message Queuing method.

次のコード例は、ReceiveByCorrelationId(String, MessageQueueTransactionType) の使用方法を示します。The following code example demonstrates the use of ReceiveByCorrelationId(String, MessageQueueTransactionType).


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

// Create a new message.
Message^ msg = gcnew Message("Example Message Body");

// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;

// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType::Single);

// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;

// Receive the response message from the transactional queue.
responseMsg = transQueue->ReceiveByCorrelationId(id,
    MessageQueueTransactionType::Single);

// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
    responseMsg->CorrelationId);

transQueue->Close();
queue->Close();


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

// Create a new message.
Message msg = new Message("Example Message Body");

// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;

// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType.Single);

// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;

// Receive the response message from the transactional queue.
responseMsg = transQueue.ReceiveByCorrelationId(id,
    MessageQueueTransactionType.Single);

// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
    responseMsg.CorrelationId);

注釈

このメソッドで参照されるキューは、MessageQueueメッセージがCorrelationId、指定された一致correlationIdパラメーター。This method looks in the queue referenced by the MessageQueue for a message whose CorrelationId matches the specified correlationId parameter. 一致するメッセージがない場合、correlationIDパラメーター、例外がスローされます。If no message is found that matches the correlationID parameter, an exception is thrown. メッセージがそれ以外の場合、キューから削除し、で定義されたトランザクションのコンテキストを使用してアプリケーションに返される、transactionTypeパラメーター。Otherwise, the message is removed from the queue and returned to the application using a transaction context defined by the transactionType parameter.

指定AutomatictransactionType外部トランザクション コンテキストが既に存在する場合は、パラメーターを使用してメッセージを受信する必要のあるスレッドにアタッチされています。Specify Automatic for the transactionType parameter if there is already an external transaction context attached to the thread that you want to use to receive the message. 指定Singleとして 1 つの内部トランザクション メッセージを受信したい場合。Specify Single if you want to receive the message as a single internal transaction. 指定できるNoneトランザクション コンテキストの外でトランザクション キューからメッセージを受信する場合。You can specify None if you want to receive a message from a transactional queue outside of a transaction context.

トランザクション キューからメッセージを受信するこのメソッドが呼び出されると、受信したメッセージが返されます、キューにトランザクションが中止された場合。If this method is called to receive a message from a transactional queue, the message that is received would be returned to the queue if the transaction is aborted. メッセージは完全に削除されません、キューから、トランザクションがコミットされるまで。The message is not permanently removed from the queue until the transaction is committed.

CorrelationIdに関連する応答、レポート、または受信確認メッセージをキューに送信されるメッセージを関連付けるプロパティを使用します。The CorrelationId property is used to tie a message sent to the queue to associated response, report, or acknowledgment messages.

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。Two other methods allow you to receive messages from a queue. Receiveメソッドは、キュー内の最初のメッセージを返します、ReceiveById(String)メソッドを使用して、その一意の識別子を指定することで、メッセージを取得します。The Receive method returns the first message in the queue, and the ReceiveById(String) method is used to retrieve a message by specifying its unique identifier.

キューから削除せずに指定した相関 id のメッセージを読み取り、使用、PeekByCorrelationId(String)メソッド。To read a message with a specified correlation identifier without removing it from the queue, use the PeekByCorrelationId(String) method. PeekByCorrelationId(String)メソッドがメソッドに対する後続の呼び出しより高い優先度のメッセージがキューに到着しない限り、同じメッセージが返されるように、キューで最初のメッセージが常を返します。The PeekByCorrelationId(String) method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue. 呼び出しによって返されるメッセージに関連付けられたトランザクション コンテキストがないPeekByCorrelationId(String)します。There is no transaction context associated with a message returned by a call to PeekByCorrelationId(String). PeekByCorrelationId(String)キューにメッセージは削除されませんがあるトランザクションが中止された場合はロールバックするものがありません。Because PeekByCorrelationId(String) does not remove any messages in the queue, there would be nothing to roll back if the transaction were aborted.

次の表では、このメソッドは、さまざまなワークグループ モードで使用するかどうかを示します。The following table shows whether this method is available in various Workgroup modes.

ワークグループ モードWorkgroup mode 使用可能Available
ローカル コンピューターLocal computer はいYes
ローカル コンピューターと直接形式名Local computer and direct format name はいYes
リモート コンピューターRemote computer いいえNo
リモート コンピューターと直接形式名Remote computer and direct format name はいYes
こちらもご覧ください

ReceiveByCorrelationId(String, MessageQueueTransaction) ReceiveByCorrelationId(String, MessageQueueTransaction) ReceiveByCorrelationId(String, MessageQueueTransaction) ReceiveByCorrelationId(String, MessageQueueTransaction)

指定した相関 ID と一致するメッセージを (トランザクション キューから) 受信します。現在、指定した相関 ID と一致するメッセージがキューに存在しない場合は、すぐに例外を発生させます。Receives the message that matches the given correlation identifier (from a transactional queue) and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId, System::Messaging::MessageQueueTransaction ^ transaction);
public System.Messaging.Message ReceiveByCorrelationId (string correlationId, System.Messaging.MessageQueueTransaction transaction);
member this.ReceiveByCorrelationId : string * System.Messaging.MessageQueueTransaction -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String, transaction As MessageQueueTransaction) As Message

パラメーター

correlationId
String String String String

受信するメッセージの CorrelationIdThe CorrelationId of the message to receive.

戻り値

渡された correlationId パラメーターと一致する CorrelationId を持つ MessageThe Message whose CorrelationId matches the correlationId parameter passed in.

例外

correlationId パラメーターが null です。The correlationId parameter is null.

または-or- transaction パラメーターが null です。The transaction parameter is null.

指定した correlationId を持つメッセージは見つかりませんでした。The message with the specified correlationId could not be found.

キューが非トランザクション キューです。The queue is non-transactional.

または-or-

メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。An error occurred when accessing a Message Queuing method.

次のコード例は、ReceiveByCorrelationId(String, MessageQueueTransaction) の使用方法を示します。The following code example demonstrates the use of ReceiveByCorrelationId(String, MessageQueueTransaction).


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

// Create a new message.
Message^ msg = gcnew Message("Example Message Body");

// Send the message to the nontransactional queue.
queue->Send(msg, "Example Message Label");

// Get the message's Id property value.
String^ id = msg->Id;

// Receive the message from the nontransactional queue.
msg = queue->ReceiveById(id, TimeSpan::FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message^ responseMsg = gcnew Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg->CorrelationId = id;

// Send the response message to the transactional queue.
transQueue->Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType::Single);

// Simulate doing other work so the message has time to arrive.
System::Threading::Thread::Sleep(TimeSpan::FromSeconds(10.0));

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue->MessageReadPropertyFilter->CorrelationId = true;

// Create a message queuing transaction.
MessageQueueTransaction^ transaction = gcnew MessageQueueTransaction();

try
{
    // Begin a transaction.
    transaction->Begin();

    // Receive the response message from the transactional queue.
    responseMsg = transQueue->ReceiveByCorrelationId(id, transaction);

    // Commit the transaction.
    transaction->Commit();
}
catch (Exception^ ex)
{
    // Cancel the transaction.
    transaction->Abort();

    // Propagate the exception.
    throw ex;
}
finally
{
    // Dispose of the transaction object.
    delete transaction;
    transQueue->Close();
    queue->Close(); 
}

// Display the response message's property values.
Console::WriteLine("Message.Label: {0}", responseMsg->Label);
Console::WriteLine("Message.CorrelationId: {0}",
    responseMsg->CorrelationId);


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

// Create a new message.
Message msg = new Message("Example Message Body");

// Send the message to the nontransactional queue.
queue.Send(msg, "Example Message Label");

// Get the message's Id property value.
string id = msg.Id;

// Receive the message from the nontransactional queue.
msg = queue.ReceiveById(id, TimeSpan.FromSeconds(10.0));

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

// Create a new message in response to the original message.
Message responseMsg = new Message("Example Response Message Body");

// Set the response message's CorrelationId property value to the Id
// property value of the original message.
responseMsg.CorrelationId = id;

// Send the response message to the transactional queue.
transQueue.Send(responseMsg, "Example Response Message Label",
    MessageQueueTransactionType.Single);

// Simulate doing other work so the message has time to arrive.
System.Threading.Thread.Sleep(TimeSpan.FromSeconds(10.0));

// Set the transactional queue's MessageReadPropertyFilter property to
// ensure that the response message includes the desired properties.
transQueue.MessageReadPropertyFilter.CorrelationId = true;

// Create a message queuing transaction.
MessageQueueTransaction transaction = new MessageQueueTransaction();

try
{
    // Begin a transaction.
    transaction.Begin();

    // Receive the response message from the transactional queue.
    responseMsg = transQueue.ReceiveByCorrelationId(id, transaction);

    // Commit the transaction.
    transaction.Commit();
}
catch(System.Exception e)
{
    // Cancel the transaction.
    transaction.Abort();

    // Propagate the exception.
    throw e;
}
finally
{
    // Dispose of the transaction object.
    transaction.Dispose();
}

// Display the response message's property values.
Console.WriteLine("Message.Label: {0}", responseMsg.Label);
Console.WriteLine("Message.CorrelationId: {0}",
    responseMsg.CorrelationId);

注釈

このメソッドで参照されるトランザクション キューは、MessageQueueメッセージがCorrelationId、指定された一致correlationIdパラメーター。This method looks in the transactional queue referenced by the MessageQueue for a message whose CorrelationId matches the specified correlationId parameter. 一致するメッセージがない場合、correlationIDパラメーター、例外がスローされます。If no message is found that matches the correlationID parameter, an exception is thrown. メッセージがそれ以外の場合、キューから削除し、で定義された内部トランザクション コンテキストを使用してアプリケーションに返される、transactionパラメーター。Otherwise, the message is removed from the queue and returned to the application using the internal transaction context defined by the transaction parameter.

トランザクション キューでこのメソッドを呼び出したため、受信したメッセージが返されます、キューにトランザクションが中止された場合。Because this method is called on a transactional queue, the message that is received would be returned to the queue if the transaction is aborted. メッセージは完全に削除されません、キューから、トランザクションがコミットされるまで。The message is not permanently removed from the queue until the transaction is committed.

CorrelationIdに関連する応答、レポート、または受信確認メッセージをキューに送信されるメッセージを関連付けるプロパティを使用します。The CorrelationId property is used to tie a message sent to the queue to associated response, report, or acknowledgment messages.

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。Two other methods allow you to receive messages from a queue. Receiveメソッドは、キュー内の最初のメッセージを返します、ReceiveById(String)メソッドを使用して、その一意の識別子を指定することで、メッセージを取得します。The Receive method returns the first message in the queue, and the ReceiveById(String) method is used to retrieve a message by specifying its unique identifier.

キューから削除せずに指定した相関 id のメッセージを読み取り、使用、PeekByCorrelationId(String)メソッド。To read a message with a specified correlation identifier without removing it from the queue, use the PeekByCorrelationId(String) method. PeekByCorrelationId(String)メソッドがメソッドに対する後続の呼び出しより高い優先度のメッセージがキューに到着しない限り、同じメッセージが返されるように、キューで最初のメッセージが常を返します。The PeekByCorrelationId(String) method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue. 呼び出しによって返されるメッセージに関連付けられたトランザクション コンテキストがないPeekByCorrelationId(String)します。There is no transaction context associated with a message returned by a call to PeekByCorrelationId(String). PeekByCorrelationId(String)キューにメッセージは削除されませんがあるトランザクションが中止された場合はロールバックするものがありません。Because PeekByCorrelationId(String) does not remove any messages in the queue, there would be nothing to roll back if the transaction were aborted.

次の表では、このメソッドは、さまざまなワークグループ モードで使用するかどうかを示します。The following table shows whether this method is available in various Workgroup modes.

ワークグループ モードWorkgroup mode 使用可能Available
ローカル コンピューターLocal computer はいYes
ローカル コンピューターと直接形式名Local computer and direct format name はいYes
リモート コンピューターRemote computer いいえNo
リモート コンピューターと直接形式名Remote computer and direct format name はいYes
こちらもご覧ください

ReceiveByCorrelationId(String) ReceiveByCorrelationId(String) ReceiveByCorrelationId(String) ReceiveByCorrelationId(String)

指定した相関 ID と一致するメッセージを (非トランザクション キューから) 受信します。現在、指定した相関 ID と一致するメッセージがキューに存在しない場合は、すぐに例外を発生させます。Receives the message that matches the given correlation identifier (from a non-transactional queue) and immediately raises an exception if no message with the specified correlation identifier currently exists in the queue.

public:
 System::Messaging::Message ^ ReceiveByCorrelationId(System::String ^ correlationId);
public System.Messaging.Message ReceiveByCorrelationId (string correlationId);
member this.ReceiveByCorrelationId : string -> System.Messaging.Message
Public Function ReceiveByCorrelationId (correlationId As String) As Message

パラメーター

correlationId
String String String String

受信するメッセージの CorrelationIdThe CorrelationId of the message to receive.

戻り値

渡された correlationId パラメーターと一致する CorrelationId を持つ MessageThe Message whose CorrelationId matches the correlationId parameter passed in.

例外

correlationId パラメーターが null です。The correlationId parameter is null.

指定した correlationId を持つメッセージは見つかりませんでした。The message with the specified correlationId could not be found.

メッセージ キューのメソッドにアクセスしたときにエラーが発生しました。An error occurred when accessing a Message Queuing method.

次のコード例は、して、キューから注文を含むメッセージを送受信します。The following code example sends and receives a message that contains an order to and from a queue. 元のメッセージに達したかと具体的には肯定受信確認を要求がキューから取得します。It specifically requests a positive acknowledgment when the original message reaches or is retrieved from the queue.

#using <system.dll>
#using <system.messaging.dll>

using namespace System;
using namespace System::Messaging;
ref class MyNewQueue
{
public:
   static void CreateQueue( String^ queuePath )
   {
      try
      {
         if (  !MessageQueue::Exists( queuePath ) )
         {
            MessageQueue::Create( queuePath );
         }
         else
         {
            Console::WriteLine(  "{0} already exists.", queuePath );
         }
      }
      catch ( MessageQueueException^ e ) 
      {
         Console::WriteLine( e->Message );
      }

   }

   void SendMessage()
   {
      // Connect to a queue on the local computer.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );

      // Create a new message.
      Message^ myMessage = gcnew Message( "Original Message" );
      myMessage->AdministrationQueue = gcnew MessageQueue( ".\\myAdministrationQueue" );
      myMessage->AcknowledgeType = (AcknowledgeTypes)(AcknowledgeTypes::PositiveReceive | AcknowledgeTypes::PositiveArrival);

      // Send the Order to the queue.
      myQueue->Send( myMessage );
      return;
   }

   String^ ReceiveMessage()
   {
      // Connect to the a queue on the local computer.
      MessageQueue^ myQueue = gcnew MessageQueue( ".\\myQueue" );
      myQueue->MessageReadPropertyFilter->CorrelationId = true;
      array<Type^>^p = gcnew array<Type^>(1);
      p[ 0 ] = String::typeid;
      myQueue->Formatter = gcnew XmlMessageFormatter( p );
      String^ returnString = nullptr;
      try
      {
         // Receive and format the message. 
         Message^ myMessage = myQueue->Receive();

         // Display message information.
         Console::WriteLine( "____________________________________________" );
         Console::WriteLine( "Original message information--" );
         Console::WriteLine( "Body: {0}", myMessage->Body );
         Console::WriteLine( "Id: {0}", myMessage->Id );
         Console::WriteLine( "____________________________________________" );
         returnString = myMessage->Id;
      }
      catch ( MessageQueueException^ ) 
      {
         // Handle Message Queuing exceptions.
      }
      // Handle invalid serialization format.
      catch ( InvalidOperationException^ e ) 
      {
         Console::WriteLine( e->Message );
      }

      // Catch other exceptions as necessary.
      return returnString;
   }

   void ReceiveAcknowledgment( String^ messageId, String^ queuePath )
   {
      bool found = false;
      MessageQueue^ queue = gcnew MessageQueue( queuePath );
      queue->MessageReadPropertyFilter->CorrelationId = true;
      queue->MessageReadPropertyFilter->Acknowledgment = true;
      try
      {
         while ( queue->PeekByCorrelationId( messageId ) != nullptr )
         {
            Message^ myAcknowledgmentMessage = queue->ReceiveByCorrelationId( messageId );

            // Output acknowledgment message information. The correlation Id is identical
            // to the id of the original message.
            Console::WriteLine( "Acknowledgment Message Information--" );
            Console::WriteLine( "Correlation Id: {0}", myAcknowledgmentMessage->CorrelationId );
            Console::WriteLine( "Id: {0}", myAcknowledgmentMessage->Id );
            Console::WriteLine( "Acknowledgment Type: {0}", myAcknowledgmentMessage->Acknowledgment );
            Console::WriteLine( "____________________________________________" );
            found = true;
         }
      }
      catch ( InvalidOperationException^ e ) 
      {
         // This exception would be thrown if there is no (further) acknowledgment message
         // with the specified correlation Id. Only output a message if there are no messages;
         // not if the loop has found at least one.
         if ( found == false )
         {
            Console::WriteLine( e->Message );
         }

         // Handle other causes of invalid operation exception.
      }

   }

};

int main()
{
   // Create a new instance of the class.
   MyNewQueue^ myNewQueue = gcnew MyNewQueue;

   // Create new queues.
   MyNewQueue::CreateQueue( ".\\myQueue" );
   MyNewQueue::CreateQueue( ".\\myAdministrationQueue" );

   // Send messages to a queue.
   myNewQueue->SendMessage();

   // Receive messages from a queue.
   String^ messageId = myNewQueue->ReceiveMessage();

   // Receive acknowledgment message.
   if ( messageId != nullptr )
   {
      myNewQueue->ReceiveAcknowledgment( messageId, ".\\myAdministrationQueue" );
   }

   return 0;
}
using System;
using System.Messaging;

namespace MyProject
{

	/// <summary>
	/// Provides a container class for the example.
	/// </summary>
	public class MyNewQueue
	{

		//**************************************************
		// Provides an entry point into the application.
		//		 
		// This example sends and receives a message from
		// a queue.
		//**************************************************

		public static void Main()
		{
			// Create a new instance of the class.
			MyNewQueue myNewQueue = new MyNewQueue();

			// Create new queues.
			CreateQueue(".\\myQueue");
			CreateQueue(".\\myAdministrationQueue");

			// Send messages to a queue.
			myNewQueue.SendMessage();

			// Receive messages from a queue.
			string messageId = myNewQueue.ReceiveMessage(); 

			// Receive acknowledgment message.
			if(messageId != null)
			{
				myNewQueue.ReceiveAcknowledgment(messageId, ".\\myAdministrationQueue");
			}

			return;
		}

		//**************************************************
		// Creates a new queue.
		//**************************************************

		public static void CreateQueue(string queuePath)
		{
			try	
			{
				if(!MessageQueue.Exists(queuePath))
				{
					MessageQueue.Create(queuePath);
				}
				else
				{
					Console.WriteLine(queuePath + " already exists.");
				}
			}
			catch (MessageQueueException e)
			{
				Console.WriteLine(e.Message);
			}
			
		}


		//**************************************************
		// Sends a string message to a queue.
		//**************************************************
		
		public void SendMessage()
		{

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

			// Create a new message.
			Message myMessage = new Message("Original Message"); 

			myMessage.AdministrationQueue = new MessageQueue(".\\myAdministrationQueue");
			myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive | AcknowledgeTypes.PositiveArrival;

			// Send the Order to the queue.
			myQueue.Send(myMessage);

			return;
		}


		//**************************************************
		// Receives a message containing an Order.
		//**************************************************
		
		public  string ReceiveMessage()
		{
			// Connect to the a queue on the local computer.
			MessageQueue myQueue = new MessageQueue(".\\myQueue");

			myQueue.MessageReadPropertyFilter.CorrelationId = true;


			// Set the formatter to indicate body contains an Order.
			myQueue.Formatter = new XmlMessageFormatter(new Type[]
				{typeof(string)});

			string returnString = null;
			
			try
			{
				// Receive and format the message. 
				Message myMessage =	myQueue.Receive(); 


				// Display message information.
				Console.WriteLine("____________________________________________");
				Console.WriteLine("Original message information--");
				Console.WriteLine("Body: " +myMessage.Body.ToString());
				Console.WriteLine("Id: " + myMessage.Id.ToString());
				Console.WriteLine("____________________________________________");

				returnString =  myMessage.Id;
				
			}
			
			catch (MessageQueueException)
			{
				// Handle Message Queuing exceptions.
			}

			// Handle invalid serialization format.
			catch (InvalidOperationException e)
			{
				Console.WriteLine(e.Message);
			}
			
			// Catch other exceptions as necessary.

			return returnString;
		}

		//**************************************************
		// Receives a message containing an Order.
		//**************************************************
		
		public void ReceiveAcknowledgment(string messageId, string queuePath)
		{
			bool found = false;
			MessageQueue queue = new MessageQueue(queuePath);
			queue.MessageReadPropertyFilter.CorrelationId = true;
			queue.MessageReadPropertyFilter.Acknowledgment = true;

			try
			{
				while(queue.PeekByCorrelationId(messageId) != null)
				{
					Message myAcknowledgmentMessage = queue.ReceiveByCorrelationId(messageId);
			
					// Output acknowledgment message information. The correlation Id is identical
					// to the id of the original message.
					Console.WriteLine("Acknowledgment Message Information--");
					Console.WriteLine("Correlation Id: " + myAcknowledgmentMessage.CorrelationId.ToString());
					Console.WriteLine("Id: " + myAcknowledgmentMessage.Id.ToString());
					Console.WriteLine("Acknowledgment Type: " + myAcknowledgmentMessage.Acknowledgment.ToString());
					Console.WriteLine("____________________________________________");

					found = true;
				}
			}
			catch (InvalidOperationException e)
			{ 
				// This exception would be thrown if there is no (further) acknowledgment message
				// with the specified correlation Id. Only output a message if there are no messages;
				// not if the loop has found at least one.
				if(found == false)
				{	
					Console.WriteLine(e.Message);
				}

				// Handle other causes of invalid operation exception.
			}

		}
	}
}
Imports System
Imports System.Messaging


' Provides a container class for the example.

Public Class MyNewQueue
   
   

   ' Provides an entry point into the application.       
   ' This example sends and receives a message from
   ' a queue.
      
   Public Shared Sub Main()
         ' Create a new instance of the class.
         Dim myNewQueue As New MyNewQueue()
         
         ' Create new queues.
         CreateQueue(".\myQueue")
         CreateQueue(".\myAdministrationQueue")
         
         ' Send messages to a queue.
         myNewQueue.SendMessage()
         
         ' Receive messages from a queue.
         Dim messageId As String = myNewQueue.ReceiveMessage()
         
         ' Receive acknowledgment message.
         If Not (messageId Is Nothing) Then
            myNewQueue.ReceiveAcknowledgment(messageId, ".\myAdministrationQueue")
         End If
         
         Return
   End Sub 'Main
      
      
      ' Creates a new queue.

   Public Shared Sub CreateQueue(queuePath As String)
         Try
            If Not MessageQueue.Exists(queuePath) Then
               MessageQueue.Create(queuePath)
            Else
               Console.WriteLine((queuePath + " already exists."))
            End If
         Catch e As MessageQueueException
            Console.WriteLine(e.Message)
         End Try
   End Sub 'CreateQueue
       
      
      
 
      ' Sends a string message to a queue.
 
   Public Sub SendMessage()
         
         ' Connect to a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         ' Create a new message.
         Dim myMessage As New Message("Original Message")
         
         myMessage.AdministrationQueue = New MessageQueue(".\myAdministrationQueue")
         myMessage.AcknowledgeType = AcknowledgeTypes.PositiveReceive Or AcknowledgeTypes.PositiveArrival
         
         ' Send the Order to the queue.
         myQueue.Send(myMessage)
         
         Return
   End Sub 'SendMessage
      
      
      
 
      ' Receives a message containing an Order.
 
   Public Function ReceiveMessage() As String
         ' Connect to the a queue on the local computer.
         Dim myQueue As New MessageQueue(".\myQueue")
         
         myQueue.MessageReadPropertyFilter.CorrelationId = True
         
         
         ' Set the formatter to indicate body contains an Order.
         myQueue.Formatter = New XmlMessageFormatter(New Type() {GetType(String)})
         
         Dim returnString As String = Nothing
         
         Try
            ' Receive and format the message. 
            Dim myMessage As Message = myQueue.Receive()
            
            
            ' Display message information.
            Console.WriteLine("____________________________________________")
            Console.WriteLine("Original message information--")
            Console.WriteLine(("Body: " + myMessage.Body.ToString()))
            Console.WriteLine(("Id: " + myMessage.Id.ToString()))
            Console.WriteLine("____________________________________________")
            
            returnString = myMessage.Id
         
         
                  
         ' Handle invalid serialization format.
         Catch e As InvalidOperationException
            Console.WriteLine(e.Message)
         End Try
         
         ' Catch other exceptions as necessary.
         Return returnString
   End Function 'ReceiveMessage
      
      
 
      ' Receives a message containing an Order.
 
   Public Sub ReceiveAcknowledgment(messageId As String, queuePath As String)
         Dim found As Boolean = False
         Dim queue As New MessageQueue(queuePath)
         queue.MessageReadPropertyFilter.CorrelationId = True
         queue.MessageReadPropertyFilter.Acknowledgment = True
         
         Try
            While Not (queue.PeekByCorrelationId(messageId) Is Nothing)
               Dim myAcknowledgmentMessage As Message = queue.ReceiveByCorrelationId(messageId)
               
               ' Output acknowledgment message information. The correlation Id is identical
               ' to the id of the original message.
               Console.WriteLine("Acknowledgment Message Information--")
               Console.WriteLine(("Correlation Id: " + myAcknowledgmentMessage.CorrelationId.ToString()))
               Console.WriteLine(("Id: " + myAcknowledgmentMessage.Id.ToString()))
               Console.WriteLine(("Acknowledgment Type: " + myAcknowledgmentMessage.Acknowledgment.ToString()))
               Console.WriteLine("____________________________________________")
               
               found = True
            End While
         Catch e As InvalidOperationException
            ' This exception would be thrown if there is no (further) acknowledgment message
            ' with the specified correlation Id. Only output a message if there are no messages;
            ' not if the loop has found at least one.
            If found = False Then
               Console.WriteLine(e.Message)
            End If
         End Try 
   End Sub 'ReceiveAcknowledgment ' Handle other causes of invalid operation exception.
 End Class 'MyNewQueue

注釈

このメソッドで参照される非トランザクション キューは、MessageQueueメッセージがCorrelationId、指定された一致correlationIdパラメーター。This method looks in the non-transactional queue referenced by the MessageQueue for a message whose CorrelationId matches the specified correlationId parameter. 一致するメッセージがない場合、correlationIDパラメーター、例外がスローされます。If no message is found that matches the correlationID parameter, an exception is thrown. それ以外の場合、メッセージがキューから削除し、アプリケーションに返されます。Otherwise, the message is removed from the queue and returned to the application.

CorrelationIdに関連する応答、レポート、または受信確認メッセージをキューに送信されるメッセージを関連付けるプロパティを使用します。The CorrelationId property is used to tie a message sent to the queue to associated response, report, or acknowledgment messages.

その他の 2 つのメソッドを使用すると、キューからメッセージを受信できます。Two other methods allow you to receive messages from a queue. Receiveメソッドは、キュー内の最初のメッセージを返します、ReceiveById(String)メソッドの一意の識別子を指定することで、メッセージを取得します。The Receive method returns the first message in the queue, and the ReceiveById(String) method retrieves a message by specifying its unique identifier.

キューから削除せずに指定した相関 id のメッセージを読み取り、使用、PeekByCorrelationId(String)メソッド。To read a message with a specified correlation identifier without removing it from the queue, use the PeekByCorrelationId(String) method. PeekByCorrelationId(String)メソッドがメソッドに対する後続の呼び出しより高い優先度のメッセージがキューに到着しない限り、同じメッセージが返されるように、キューで最初のメッセージが常を返します。The PeekByCorrelationId(String) method always returns the first message in the queue, so subsequent calls to the method return the same message unless a higher priority message arrives in the queue.

次の表では、このメソッドは、さまざまなワークグループ モードで使用するかどうかを示します。The following table shows whether this method is available in various Workgroup modes.

ワークグループ モードWorkgroup mode 使用可能Available
ローカル コンピューターLocal computer はいYes
ローカル コンピューターと直接形式名Local computer and direct format name はいYes
リモート コンピューターRemote computer いいえNo
リモート コンピューターと直接形式名Remote computer and direct format name はいYes
こちらもご覧ください

適用対象