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

定義

接收符合指定關聯識別項的訊息。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)

接收符合指定關聯識別項的訊息,並且等待佇列中出現具有指定關聯識別項的訊息,或者逾時到期。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)

接收符合指定關聯識別項的訊息 (從交易佇列中),並且等待佇列中出現具有指定關聯識別項的訊息,或者逾時到期。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)

接收符合指定關聯識別項的訊息 (從非交易佇列中),並且等待佇列中出現具有指定關聯識別項的訊息,或者逾時到期。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)

接收符合指定關聯識別項的訊息,如果佇列中目前不存在具有指定關聯識別項的訊息,則立即引發例外狀況。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)

接收符合指定關聯識別項的訊息 (從交易佇列中),如果佇列中目前不存在具有指定關聯識別項的訊息,則立即引發例外狀況。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)

接收符合指定關聯識別項的訊息 (從非交易佇列中),如果佇列中目前不存在具有指定關聯識別項的訊息,則立即引發例外狀況。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)

接收符合指定關聯識別項的訊息,並且等待佇列中出現具有指定關聯識別項的訊息,或者逾時到期。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

TimeSpan,指出等待新訊息可以進行檢查的時間。A TimeSpan that indicates the time to wait until a new message is available for inspection.

transactionType
MessageQueueTransactionType MessageQueueTransactionType MessageQueueTransactionType MessageQueueTransactionType

其中一個 MessageQueueTransactionType 值,描述要與訊息相關聯的異動內容的類型。One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

傳回

傳入符合 correlationId 參數的 MessageCorrelationIdThe Message whose CorrelationId matches the correlationId parameter passed in.

例外狀況

correlationId 參數為 nullThe correlationId parameter is null.

找不到具有指定 correlationId 的訊息。The message with the specified correlationId could not be found.

timeout 參數指定的值無效,可能是 timeout 小於 Zero 或大於 InfiniteTimeoutThe value specified for the timeout parameter is not valid, possibly timeout is less than Zero or greater than InfiniteTimeout.

transactionType 參數不是其中一個 MessageQueueTransactionType 成員。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. 如果具有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. 如果不是, 這個方法會啟動超時期間, 並等候另一個新訊息到達。If not, this method starts the time-out period over and waits for another new message to arrive. 因此, 如果新的訊息在超時時間內持續抵達, 則此方法可能會無限期地繼續執行, 直到超時期間到期, 而沒有到達任何新訊息, 或直到訊息抵達, 其CorrelationIdcorrelationId符合參數。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. 如果Automatic已經有transactionType附加至您要用來接收訊息之執行緒的外部交易內容, 請為參數指定。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您想要以單一內部交易的形式接收訊息, 請指定。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.

另外兩種方法可讓您從佇列接收訊息。Two other methods allow you to receive messages from a queue. 方法會傳回佇列中的第一個訊息, ReceiveById(String)而方法則是藉由指定其唯一識別碼來取得訊息。 ReceiveThe 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.

若要讀取具有指定相互關聯識別碼的訊息, 而不將它從佇列中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)

接收符合指定關聯識別項的訊息 (從交易佇列中),並且等待佇列中出現具有指定關聯識別項的訊息,或者逾時到期。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

TimeSpan,指出等待新訊息可以進行檢查的時間。A TimeSpan that indicates the time to wait until a new message is available for inspection.

傳回

傳入符合 correlationId 參數的 MessageCorrelationIdThe Message whose CorrelationId matches the correlationId parameter passed in.

例外狀況

correlationId 參數為 nullThe correlationId parameter is null.

-或--or- transaction 參數為 nullThe transaction parameter is null.

timeout 參數指定的值無效,可能是 timeout 小於 Zero 或大於 InfiniteTimeoutThe 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. 如果具有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. 如果不是, 這個方法會啟動超時期間, 並等候另一個新訊息到達。If not, this method starts the time-out period over and waits for another new message to arrive. 因此, 如果新的訊息在超時時間內持續抵達, 則此方法可能會無限期地繼續執行, 直到超時期間到期, 而沒有到達任何新訊息, 或直到訊息抵達, 其CorrelationIdcorrelationId符合參數。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.

另外兩種方法可讓您從佇列接收訊息。Two other methods allow you to receive messages from a queue. 方法會傳回佇列中的第一個訊息, ReceiveById(String)而方法則是藉由指定其唯一識別碼來取得訊息。 ReceiveThe 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.

若要讀取具有指定相互關聯識別碼的訊息, 而不將它從佇列中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)

接收符合指定關聯識別項的訊息 (從非交易佇列中),並且等待佇列中出現具有指定關聯識別項的訊息,或者逾時到期。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

TimeSpan,指出等待新訊息可以進行檢查的時間。A TimeSpan that indicates the time to wait until a new message is available for inspection.

傳回

傳入符合 correlationId 參數的 MessageCorrelationIdThe Message whose CorrelationId matches the correlationId parameter passed in.

例外狀況

correlationId 參數為 nullThe correlationId parameter is null.

timeout 參數指定的值無效,可能是 timeout 小於 Zero 或大於 InfiniteTimeoutThe 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. 如果具有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. 如果不是, 這個方法會啟動超時期間, 並等候另一個新訊息到達。If not, this method starts the time-out period over and waits for another new message to arrive. 因此, 如果新的訊息在超時時間內持續抵達, 則此方法可能會無限期地繼續執行, 直到超時期間到期, 而沒有到達任何新訊息, 或直到訊息抵達, 其CorrelationIdcorrelationId符合參數。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.

另外兩種方法可讓您從佇列接收訊息。Two other methods allow you to receive messages from a queue. 方法會傳回佇列中的第一個訊息, ReceiveById(String)而方法則是藉由指定其唯一識別碼來取得訊息。 ReceiveThe 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.

若要讀取具有指定相互關聯識別碼的訊息, 而不將它從佇列中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)

接收符合指定關聯識別項的訊息,如果佇列中目前不存在具有指定關聯識別項的訊息,則立即引發例外狀況。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 值,描述要與訊息相關聯的異動內容的類型。One of the MessageQueueTransactionType values, describing the type of transaction context to associate with the message.

傳回

傳入符合 correlationId 參數的 MessageCorrelationIdThe Message whose CorrelationId matches the correlationId parameter passed in.

例外狀況

correlationId 參數為 nullThe correlationId parameter is null.

找不到具有指定 correlationId 的訊息。The message with the specified correlationId could not be found.

transactionType 參數不是其中一個 MessageQueueTransactionType 成員。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.

如果Automatic已經有transactionType附加至您要用來接收訊息之執行緒的外部交易內容, 請為參數指定。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您想要以單一內部交易的形式接收訊息, 請指定。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.

另外兩種方法可讓您從佇列接收訊息。Two other methods allow you to receive messages from a queue. 方法會傳回佇列中的第一個訊息, ReceiveById(String)而方法則是藉由指定其唯一識別碼來取得訊息。 ReceiveThe 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.

若要讀取具有指定相互關聯識別碼的訊息, 而不將它從佇列中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)

接收符合指定關聯識別項的訊息 (從交易佇列中),如果佇列中目前不存在具有指定關聯識別項的訊息,則立即引發例外狀況。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 參數的 MessageCorrelationIdThe Message whose CorrelationId matches the correlationId parameter passed in.

例外狀況

correlationId 參數為 nullThe correlationId parameter is null.

-或--or- transaction 參數為 nullThe 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.

另外兩種方法可讓您從佇列接收訊息。Two other methods allow you to receive messages from a queue. 方法會傳回佇列中的第一個訊息, ReceiveById(String)而方法則是藉由指定其唯一識別碼來取得訊息。 ReceiveThe 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.

若要讀取具有指定相互關聯識別碼的訊息, 而不將它從佇列中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)

接收符合指定關聯識別項的訊息 (從非交易佇列中),如果佇列中目前不存在具有指定關聯識別項的訊息,則立即引發例外狀況。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 參數的 MessageCorrelationIdThe Message whose CorrelationId matches the correlationId parameter passed in.

例外狀況

correlationId 參數為 nullThe 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.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
      
      
      ' 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
       
      
      
 
      ' 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
      
      
      
 
      ' 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
 End Class

備註

這個方法會在所參考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.

另外兩種方法可讓您從佇列接收訊息。Two other methods allow you to receive messages from a queue. 方法會傳回佇列中的第一個訊息, ReceiveById(String)而方法會藉由指定其唯一識別碼來抓取訊息。 ReceiveThe Receive method returns the first message in the queue, and the ReceiveById(String) method retrieves a message by specifying its unique identifier.

若要讀取具有指定相互關聯識別碼的訊息, 而不將它從佇列中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
另請參閱

適用於