MessageQueue.ReceiveByCorrelationId Metod

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

Parametrar

Returer

Vars Message matchar parametern CorrelationId som correlationId skickades in.

Undantag

Exempel

I följande kodexempel visas användningen av 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);

Kommentarer

Den här metoden söker i kön som refereras av MessageQueue för ett meddelande vars CorrelationId matchar den angivna correlationId parametern. Den här metoden returnerar omedelbart om meddelandet med korrelationsidentifieraren som anges av parametern correlationId finns i kön med hjälp av en transaktionskontext som definieras av parametern transactionType . Annars väntar metoden den angivna tidsperioden på att ett nytt meddelande ska tas emot. Om ett nytt meddelande inte tas emot innan tidsgränsen upphör att gälla utlöses ett undantag.

Parametern timeout anger inte den totala körningstiden för den här metoden. I stället anger den tiden för att vänta tills ett nytt meddelande tas emot i kön. Varje gång ett nytt meddelande tas emot undersöker CorrelationId den här metoden det nya meddelandets för att se om det matchar parametern correlationId . Annars startar den här metoden tidsgränsen och väntar på att ett nytt meddelande ska tas emot. Om nya meddelanden fortsätter att tas emot inom tidsgränsen är det därför möjligt att den här metoden fortsätter att köras på obestämd tid, antingen tills tidsgränsen upphör att gälla utan att några nya meddelanden kommer eller tills ett meddelande anländer vars CorrelationId matchar parametern correlationId . Ange Automatic för parametern transactionType om det redan finns en extern transaktionskontext kopplad till tråden som du vill använda för att ta emot meddelandet. Ange Single om du vill ta emot meddelandet som en enda intern transaktion. Du kan ange None om du vill ta emot ett meddelande från en transaktionskö utanför en transaktionskontext.

Om den här metoden anropas för att ta emot ett meddelande från en transaktionskö returneras meddelandet som tas emot till kön om transaktionen avbryts. Meddelandet tas inte bort permanent från kön förrän transaktionen har checkats in.

Egenskapen CorrelationId används för att koppla ett meddelande som skickas till kön till associerade svars-, rapport- eller bekräftelsemeddelanden.

Med två andra metoder kan du ta emot meddelanden från en kö. Metoden Receive returnerar det första meddelandet i kön och ReceiveById(String) metoden används för att hämta ett meddelande genom att ange dess unika identifierare.

Om du vill läsa ett meddelande med en angiven korrelationsidentifierare utan att ta bort det från kön använder du PeekByCorrelationId(String) metoden . Metoden PeekByCorrelationId(String) returnerar alltid det första meddelandet i kön, så efterföljande anrop till metoden returnerar samma meddelande om inte ett meddelande med högre prioritet kommer in i kön. Det finns ingen transaktionskontext som är associerad med ett meddelande som returneras av ett anrop till PeekByCorrelationId(String). Eftersom PeekByCorrelationId(String) inga meddelanden tas bort i kön skulle det inte finnas något att återställa om transaktionen avbröts.

I följande tabell visas om den här metoden är tillgänglig i olika arbetsgruppslägen.

Se även

• MessageQueueTransactionType
• Transactional
• Receive()
• Peek()
• BeginReceive()

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

Parametrar

Returer

Vars Message matchar parametern CorrelationId som correlationId skickades in.

Undantag

Exempel

I följande kodexempel visas användningen av 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);

Kommentarer

Den här metoden söker i transaktionskö som MessageQueue refereras av för ett meddelande vars CorrelationId matchar den angivna correlationId parametern. Den här metoden returnerar omedelbart om meddelandet med korrelationsidentifieraren som anges av parametern correlationId finns i kön med hjälp av den interna transaktionskontext som definieras av parametern transaction . Annars väntar metoden den angivna tidsperioden på att ett nytt meddelande ska tas emot. Om ett nytt meddelande inte tas emot innan tidsgränsen upphör att gälla utlöses ett undantag.

Parametern timeout anger inte den totala körningstiden för den här metoden. I stället anger den tiden för att vänta tills ett nytt meddelande tas emot i kön. Varje gång ett nytt meddelande tas emot undersöker CorrelationId den här metoden det nya meddelandets för att se om det matchar parametern correlationId . Annars startar den här metoden tidsgränsen och väntar på att ett nytt meddelande ska tas emot. Om nya meddelanden fortsätter att tas emot inom tidsgränsen är det därför möjligt att den här metoden fortsätter att köras på obestämd tid, antingen tills tidsgränsen upphör att gälla utan att några nya meddelanden kommer eller tills ett meddelande anländer vars CorrelationId matchar parametern correlationId .

Eftersom den här metoden anropas i en transaktionskö returneras meddelandet som tas emot till kön om transaktionen avbryts. Meddelandet tas inte bort permanent från kön förrän transaktionen har checkats in.

Egenskapen CorrelationId används för att koppla ett meddelande som skickas till kön till associerade svars-, rapport- eller bekräftelsemeddelanden.

Med två andra metoder kan du ta emot meddelanden från en kö. Metoden Receive returnerar det första meddelandet i kön och ReceiveById(String) metoden används för att hämta ett meddelande genom att ange dess unika identifierare.

Om du vill läsa ett meddelande med en angiven korrelationsidentifierare utan att ta bort det från kön använder du PeekByCorrelationId(String) metoden . Metoden PeekByCorrelationId(String) returnerar alltid det första meddelandet i kön, så efterföljande anrop till metoden returnerar samma meddelande om inte ett meddelande med högre prioritet kommer in i kön. Det finns ingen transaktionskontext som är associerad med ett meddelande som returneras av ett anrop till PeekByCorrelationId(String). Eftersom PeekByCorrelationId(String) inga meddelanden tas bort i kön skulle det inte finnas något att återställa om transaktionen avbröts.

I följande tabell visas om den här metoden är tillgänglig i olika arbetsgruppslägen.

Se även

• MessageQueueTransaction
• Transactional
• InfiniteTimeout
• Receive()
• Peek()
• BeginReceive()

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

Parametrar

Returer

Vars Message matchar parametern CorrelationId som correlationId skickades in.

Undantag

Exempel

I följande kodexempel visas användningen av 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);

Kommentarer

Den här metoden söker i den icke-transaktionella kö som refereras av MessageQueue för ett meddelande vars CorrelationId matchar den angivna correlationId parametern. Den här metoden returnerar omedelbart om meddelandet med korrelationsidentifieraren som anges av parametern correlationId finns i kön. Annars väntar metoden den angivna tidsperioden på att ett nytt meddelande ska tas emot. Om ett nytt meddelande inte tas emot innan tidsgränsen upphör att gälla utlöses ett undantag.

Parametern timeout anger inte den totala körningstiden för den här metoden. I stället anger den tiden för att vänta tills ett nytt meddelande tas emot i kön. Varje gång ett nytt meddelande tas emot undersöker CorrelationId den här metoden det nya meddelandets för att se om det matchar parametern correlationId . Annars startar den här metoden tidsgränsen och väntar på att ett nytt meddelande ska tas emot. Om nya meddelanden fortsätter att tas emot inom tidsgränsen är det därför möjligt att den här metoden fortsätter att köras på obestämd tid, antingen tills tidsgränsen upphör att gälla utan att några nya meddelanden kommer eller tills ett meddelande anländer vars CorrelationId matchar parametern correlationId .

Egenskapen CorrelationId används för att koppla ett meddelande som skickas till kön till associerade svars-, rapport- eller bekräftelsemeddelanden.

Med två andra metoder kan du ta emot meddelanden från en kö. Metoden Receive returnerar det första meddelandet i kön och ReceiveById(String) metoden används för att hämta ett meddelande genom att ange dess unika identifierare.

Om du vill läsa ett meddelande med en angiven korrelationsidentifierare utan att ta bort det från kön använder du PeekByCorrelationId(String) metoden . Metoden PeekByCorrelationId(String) returnerar alltid det första meddelandet i kön, så efterföljande anrop till metoden returnerar samma meddelande om inte ett meddelande med högre prioritet kommer in i kön.

I följande tabell visas om den här metoden är tillgänglig i olika arbetsgruppslägen.

Se även

• InfiniteTimeout
• Receive()
• Peek()
• BeginReceive()

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

Parametrar

Returer

Vars Message matchar parametern CorrelationId som correlationId skickades in.

Undantag

Exempel

I följande kodexempel visas användningen av 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);

Kommentarer

Den här metoden söker i kön som refereras av MessageQueue för ett meddelande vars CorrelationId matchar den angivna correlationId parametern. Om inget meddelande hittas som matchar parametern correlationID genereras ett undantag. Annars tas meddelandet bort från kön och returneras till programmet med hjälp av en transaktionskontext som definieras av parametern transactionType .

Ange Automatic för parametern transactionType om det redan finns en extern transaktionskontext kopplad till tråden som du vill använda för att ta emot meddelandet. Ange Single om du vill ta emot meddelandet som en enda intern transaktion. Du kan ange None om du vill ta emot ett meddelande från en transaktionskö utanför en transaktionskontext.

Om den här metoden anropas för att ta emot ett meddelande från en transaktionskö returneras meddelandet som tas emot till kön om transaktionen avbryts. Meddelandet tas inte bort permanent från kön förrän transaktionen har checkats in.

Egenskapen CorrelationId används för att koppla ett meddelande som skickas till kön till associerade svars-, rapport- eller bekräftelsemeddelanden.

Med två andra metoder kan du ta emot meddelanden från en kö. Metoden Receive returnerar det första meddelandet i kön och ReceiveById(String) metoden används för att hämta ett meddelande genom att ange dess unika identifierare.

Om du vill läsa ett meddelande med en angiven korrelationsidentifierare utan att ta bort det från kön använder du PeekByCorrelationId(String) metoden . Metoden PeekByCorrelationId(String) returnerar alltid det första meddelandet i kön, så efterföljande anrop till metoden returnerar samma meddelande om inte ett meddelande med högre prioritet kommer in i kön. Det finns ingen transaktionskontext som är associerad med ett meddelande som returneras av ett anrop till PeekByCorrelationId(String). Eftersom PeekByCorrelationId(String) inga meddelanden tas bort i kön skulle det inte finnas något att återställa om transaktionen avbröts.

I följande tabell visas om den här metoden är tillgänglig i olika arbetsgruppslägen.

Se även

• MessageQueueTransactionType
• Transactional
• Receive()
• Peek()
• BeginReceive()

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

Parametrar

Returer

Vars Message matchar parametern CorrelationId som correlationId skickades in.

Undantag

Exempel

I följande kodexempel visas användningen av 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);

Kommentarer

Den här metoden söker i transaktionskö som MessageQueue refereras av för ett meddelande vars CorrelationId matchar den angivna correlationId parametern. Om inget meddelande hittas som matchar parametern correlationID genereras ett undantag. Annars tas meddelandet bort från kön och returneras till programmet med hjälp av den interna transaktionskontext som definieras av parametern transaction .

Eftersom den här metoden anropas i en transaktionskö returneras meddelandet som tas emot till kön om transaktionen avbryts. Meddelandet tas inte bort permanent från kön förrän transaktionen har checkats in.

Egenskapen CorrelationId används för att koppla ett meddelande som skickas till kön till associerade svars-, rapport- eller bekräftelsemeddelanden.

Med två andra metoder kan du ta emot meddelanden från en kö. Metoden Receive returnerar det första meddelandet i kön och ReceiveById(String) metoden används för att hämta ett meddelande genom att ange dess unika identifierare.

Om du vill läsa ett meddelande med en angiven korrelationsidentifierare utan att ta bort det från kön använder du PeekByCorrelationId(String) metoden . Metoden PeekByCorrelationId(String) returnerar alltid det första meddelandet i kön, så efterföljande anrop till metoden returnerar samma meddelande om inte ett meddelande med högre prioritet kommer in i kön. Det finns ingen transaktionskontext som är associerad med ett meddelande som returneras av ett anrop till PeekByCorrelationId(String). Eftersom PeekByCorrelationId(String) inga meddelanden tas bort i kön skulle det inte finnas något att återställa om transaktionen avbröts.

I följande tabell visas om den här metoden är tillgänglig i olika arbetsgruppslägen.

Se även

• MessageQueueTransaction
• Transactional
• Receive()
• Peek()
• BeginReceive()

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

Parametrar

Returer

Vars Message matchar parametern CorrelationId som correlationId skickades in.

Undantag

Exempel

Följande kodexempel skickar och tar emot ett meddelande som innehåller en order till och från en kö. Den begär specifikt en positiv bekräftelse när det ursprungliga meddelandet når eller hämtas från kön.

#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 )
         {
            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)
                {	
                    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

Kommentarer

Den här metoden söker i den icke-transaktionella kö som refereras av MessageQueue för ett meddelande vars CorrelationId matchar den angivna correlationId parametern. Om inget meddelande hittas som matchar parametern correlationID genereras ett undantag. Annars tas meddelandet bort från kön och returneras till programmet.

Egenskapen CorrelationId används för att koppla ett meddelande som skickas till kön till associerade svars-, rapport- eller bekräftelsemeddelanden.

Med två andra metoder kan du ta emot meddelanden från en kö. Metoden Receive returnerar det första meddelandet i kön och ReceiveById(String) metoden hämtar ett meddelande genom att ange dess unika identifierare.

Om du vill läsa ett meddelande med en angiven korrelationsidentifierare utan att ta bort det från kön använder du PeekByCorrelationId(String) metoden . Metoden PeekByCorrelationId(String) returnerar alltid det första meddelandet i kön, så efterföljande anrop till metoden returnerar samma meddelande om inte ett meddelande med högre prioritet kommer in i kön.

I följande tabell visas om den här metoden är tillgänglig i olika arbetsgruppslägen.

Se även

• Receive()
• Peek()
• BeginReceive()