Partager via

MessageQueue.ReceiveByCorrelationId Méthode

  • Référence

Définition

Espace de noms:
System.Messaging
Assembly:
System.Messaging.dll

Reçoit un message qui correspond à un identificateur de corrélation donné.

Surcharges

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)

Reçoit le message qui correspond à l’identificateur de corrélation donné et attend qu’un message avec l’identificateur de corrélation spécifié soit disponible dans la file d’attente, soit que le délai d’expiration expire.
ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente transactionnelle) et attend qu’un message avec l’identificateur de corrélation spécifié soit disponible dans la file d’attente, soit que le délai d’expiration expire.
ReceiveByCorrelationId(String, TimeSpan)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente non transactionnelle) et attend qu’un message avec l’identificateur de corrélation spécifié soit disponible dans la file d’attente, soit que le délai d’expiration expire.
ReceiveByCorrelationId(String, MessageQueueTransactionType)

Reçoit le message qui correspond à l’identificateur de corrélation donné et déclenche immédiatement une exception si aucun message avec l’identificateur de corrélation spécifié existe actuellement dans la file d’attente.
ReceiveByCorrelationId(String, MessageQueueTransaction)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente transactionnelle) et déclenche immédiatement une exception si aucun message avec l’identificateur de corrélation spécifié existe actuellement dans la file d’attente.
ReceiveByCorrelationId(String)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente non transactionnelle) et déclenche immédiatement une exception si aucun message avec l’identificateur de corrélation spécifié existe actuellement dans la file d’attente.

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransactionType)

Reçoit le message qui correspond à l’identificateur de corrélation donné et attend qu’un message avec l’identificateur de corrélation spécifié soit disponible dans la file d’attente, soit que le délai d’expiration expire.

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

Paramètres

correlationId
String

CorrelationId du message à recevoir.

timeout
TimeSpan

Un TimeSpan qui indique le délai d’attente jusqu’à ce qu’un nouveau message soit disponible pour inspection.

transactionType
MessageQueueTransactionType

Une des valeurs MessageQueueTransactionType, décrivant le type de contexte de transaction à associer au message.

Retours

Message

Message dont CorrelationId correspond au paramètre de correlationId passé.

Exceptions

ArgumentNullException

Le paramètre correlationId est null.

InvalidOperationException

Impossible de trouver le message avec le correlationId spécifié.

ArgumentException

La valeur spécifiée pour le paramètre timeout n’est pas valide, peut-être timeout est inférieure à Zero ou supérieure à InfiniteTimeout.

InvalidEnumArgumentException

Le paramètre transactionType n’est pas l’un des membres MessageQueueTransactionType.

MessageQueueException

Le message avec le correlationId spécifié n’existe pas dans la file d’attente et n’est pas arrivé avant l’expiration du délai d’expiration.

-ou-

Une erreur s’est produite lors de l’accès à une méthode Message Queuing.

Exemples

L’exemple de code suivant illustre l’utilisation de 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);

Remarques

Cette méthode recherche dans la file d’attente référencée par l'MessageQueue un message dont CorrelationId correspond au paramètre correlationId spécifié. Cette méthode retourne immédiatement si le message avec l’identificateur de corrélation spécifié par le paramètre correlationId se trouve dans la file d’attente, à l’aide d’un contexte de transaction défini par le paramètre transactionType. Sinon, la méthode attend la période donnée pour qu’un nouveau message arrive. Si un nouveau message n’arrive pas avant l’expiration du délai d’expiration, une exception est levée.

Le paramètre timeout ne spécifie pas le temps d’exécution total de cette méthode. Au lieu de cela, il spécifie le temps d’attendre qu’un nouveau message arrive dans la file d’attente. Chaque fois qu’un nouveau message arrive, cette méthode examine la CorrelationId du nouveau message pour voir s’il correspond au paramètre correlationId. Si ce n’est pas le cas, cette méthode démarre le délai d’attente et attend l’arrivée d’un autre nouveau message. Par conséquent, si de nouveaux messages continuent d’arriver dans le délai d’attente, il est possible que cette méthode continue à s’exécuter indéfiniment, soit jusqu’à ce que la période d’expiration expire sans aucun nouveau message arrivant, ou jusqu’à ce qu’un message arrive dont le CorrelationId correspond au paramètre de correlationId. Spécifiez Automatic pour le paramètre transactionType s’il existe déjà un contexte de transaction externe attaché au thread que vous souhaitez utiliser pour recevoir le message. Spécifiez Single si vous souhaitez recevoir le message en tant que transaction interne unique. Vous pouvez spécifier None si vous souhaitez recevoir un message d’une file d’attente transactionnelle en dehors d’un contexte de transaction.

Si cette méthode est appelée pour recevoir un message d’une file d’attente transactionnelle, le message reçu est retourné à la file d’attente si la transaction est abandonnée. Le message n’est pas supprimé définitivement de la file d’attente tant que la transaction n’est pas validée.

La propriété CorrelationId est utilisée pour lier un message envoyé à la file d’attente aux messages de réponse, de rapport ou d’accusé de réception associés.

Deux autres méthodes vous permettent de recevoir des messages d’une file d’attente. La méthode Receive retourne le premier message dans la file d’attente, et la méthode ReceiveById(String) est utilisée pour récupérer un message en spécifiant son identificateur unique.

Pour lire un message avec un identificateur de corrélation spécifié sans le supprimer de la file d’attente, utilisez la méthode PeekByCorrelationId(String). La méthode PeekByCorrelationId(String) retourne toujours le premier message dans la file d’attente, de sorte que les appels suivants à la méthode retournent le même message, sauf si un message de priorité supérieure arrive dans la file d’attente. Aucun contexte de transaction n’est associé à un message retourné par un appel à PeekByCorrelationId(String). Étant donné que PeekByCorrelationId(String) ne supprime aucun message dans la file d’attente, il n’y aurait rien à restaurer si la transaction a été abandonnée.

Le tableau suivant indique si cette méthode est disponible dans différents modes de groupe de travail.

Mode groupe de travail Disponible
Ordinateur local Oui
Ordinateur local et nom de format direct Oui
Ordinateur distant Non
Ordinateur distant et nom de format direct Oui

Voir aussi

S’applique à

ReceiveByCorrelationId(String, TimeSpan, MessageQueueTransaction)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente transactionnelle) et attend qu’un message avec l’identificateur de corrélation spécifié soit disponible dans la file d’attente, soit que le délai d’expiration expire.

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

Paramètres

correlationId
String

CorrelationId du message à recevoir.

timeout
TimeSpan

Un TimeSpan qui indique le délai d’attente jusqu’à ce qu’un nouveau message soit disponible pour inspection.

transaction
MessageQueueTransaction

Objet MessageQueueTransaction.

Retours

Message

Message dont CorrelationId correspond au paramètre de correlationId passé.

Exceptions

ArgumentNullException

Le paramètre correlationId est null.

-ou-

Le paramètre transaction est null.

ArgumentException

La valeur spécifiée pour le paramètre timeout n’est pas valide, peut-être timeout est inférieure à Zero ou supérieure à InfiniteTimeout.

MessageQueueException

Le message avec le correlationId spécifié n’existe pas dans la file d’attente et n’est pas arrivé avant l’expiration du délai d’expiration.

-ou-

La file d’attente n’est pas transactionnelle.

-ou-

Une erreur s’est produite lors de l’accès à une méthode Message Queuing.

Exemples

L’exemple de code suivant illustre l’utilisation de 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);

Remarques

Cette méthode recherche dans la file d’attente transactionnelle référencée par l'MessageQueue un message dont CorrelationId correspond au paramètre correlationId spécifié. Cette méthode retourne immédiatement si le message avec l’identificateur de corrélation spécifié par le paramètre correlationId se trouve dans la file d’attente, à l’aide du contexte de transaction interne défini par le paramètre transaction. Sinon, la méthode attend la période donnée pour qu’un nouveau message arrive. Si un nouveau message n’arrive pas avant l’expiration du délai d’expiration, une exception est levée.

Le paramètre timeout ne spécifie pas le temps d’exécution total de cette méthode. Au lieu de cela, il spécifie le temps d’attendre qu’un nouveau message arrive dans la file d’attente. Chaque fois qu’un nouveau message arrive, cette méthode examine la CorrelationId du nouveau message pour voir s’il correspond au paramètre correlationId. Si ce n’est pas le cas, cette méthode démarre le délai d’attente et attend l’arrivée d’un autre nouveau message. Par conséquent, si de nouveaux messages continuent d’arriver dans le délai d’attente, il est possible que cette méthode continue à s’exécuter indéfiniment, soit jusqu’à ce que la période d’expiration expire sans aucun nouveau message arrivant, ou jusqu’à ce qu’un message arrive dont le CorrelationId correspond au paramètre de correlationId.

Étant donné que cette méthode est appelée sur une file d’attente transactionnelle, le message reçu est retourné à la file d’attente si la transaction est abandonnée. Le message n’est pas supprimé définitivement de la file d’attente tant que la transaction n’est pas validée.

La propriété CorrelationId est utilisée pour lier un message envoyé à la file d’attente aux messages de réponse, de rapport ou d’accusé de réception associés.

Deux autres méthodes vous permettent de recevoir des messages d’une file d’attente. La méthode Receive retourne le premier message dans la file d’attente, et la méthode ReceiveById(String) est utilisée pour récupérer un message en spécifiant son identificateur unique.

Pour lire un message avec un identificateur de corrélation spécifié sans le supprimer de la file d’attente, utilisez la méthode PeekByCorrelationId(String). La méthode PeekByCorrelationId(String) retourne toujours le premier message dans la file d’attente, de sorte que les appels suivants à la méthode retournent le même message, sauf si un message de priorité supérieure arrive dans la file d’attente. Aucun contexte de transaction n’est associé à un message retourné par un appel à PeekByCorrelationId(String). Étant donné que PeekByCorrelationId(String) ne supprime aucun message dans la file d’attente, il n’y aurait rien à restaurer si la transaction a été abandonnée.

Le tableau suivant indique si cette méthode est disponible dans différents modes de groupe de travail.

Mode groupe de travail Disponible
Ordinateur local Oui
Ordinateur local et nom de format direct Oui
Ordinateur distant Non
Ordinateur distant et nom de format direct Oui

Voir aussi

S’applique à

ReceiveByCorrelationId(String, TimeSpan)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente non transactionnelle) et attend qu’un message avec l’identificateur de corrélation spécifié soit disponible dans la file d’attente, soit que le délai d’expiration expire.

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

Paramètres

correlationId
String

CorrelationId du message à recevoir.

timeout
TimeSpan

Un TimeSpan qui indique le délai d’attente jusqu’à ce qu’un nouveau message soit disponible pour inspection.

Retours

Message

Message dont CorrelationId correspond au paramètre de correlationId passé.

Exceptions

ArgumentNullException

Le paramètre correlationId est null.

ArgumentException

La valeur spécifiée pour le paramètre timeout n’est pas valide, peut-être timeout est inférieure à Zero ou supérieure à InfiniteTimeout.

MessageQueueException

Le message avec le correlationId spécifié n’existe pas dans la file d’attente et n’est pas arrivé avant l’expiration du délai d’expiration.

-ou-

Une erreur s’est produite lors de l’accès à une méthode Message Queuing.

Exemples

L’exemple de code suivant illustre l’utilisation de 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);

Remarques

Cette méthode examine la file d’attente non transactionnelle référencée par l'MessageQueue pour un message dont CorrelationId correspond au paramètre de correlationId spécifié. Cette méthode retourne immédiatement si le message avec l’identificateur de corrélation spécifié par le paramètre correlationId se trouve dans la file d’attente. Sinon, la méthode attend la période donnée pour qu’un nouveau message arrive. Si un nouveau message n’arrive pas avant l’expiration du délai d’expiration, une exception est levée.

Le paramètre timeout ne spécifie pas le temps d’exécution total de cette méthode. Au lieu de cela, il spécifie le temps d’attendre qu’un nouveau message arrive dans la file d’attente. Chaque fois qu’un nouveau message arrive, cette méthode examine la CorrelationId du nouveau message pour voir s’il correspond au paramètre correlationId. Si ce n’est pas le cas, cette méthode démarre le délai d’attente et attend l’arrivée d’un autre nouveau message. Par conséquent, si de nouveaux messages continuent d’arriver dans le délai d’attente, il est possible que cette méthode continue à s’exécuter indéfiniment, soit jusqu’à ce que la période d’expiration expire sans aucun nouveau message arrivant, ou jusqu’à ce qu’un message arrive dont le CorrelationId correspond au paramètre de correlationId.

La propriété CorrelationId est utilisée pour lier un message envoyé à la file d’attente aux messages de réponse, de rapport ou d’accusé de réception associés.

Deux autres méthodes vous permettent de recevoir des messages d’une file d’attente. La méthode Receive retourne le premier message dans la file d’attente, et la méthode ReceiveById(String) est utilisée pour récupérer un message en spécifiant son identificateur unique.

Pour lire un message avec un identificateur de corrélation spécifié sans le supprimer de la file d’attente, utilisez la méthode PeekByCorrelationId(String). La méthode PeekByCorrelationId(String) retourne toujours le premier message dans la file d’attente, de sorte que les appels suivants à la méthode retournent le même message, sauf si un message de priorité supérieure arrive dans la file d’attente.

Le tableau suivant indique si cette méthode est disponible dans différents modes de groupe de travail.

Mode groupe de travail Disponible
Ordinateur local Oui
Ordinateur local et nom de format direct Oui
Ordinateur distant Non
Ordinateur distant et nom de format direct Oui

Voir aussi

S’applique à

ReceiveByCorrelationId(String, MessageQueueTransactionType)

Reçoit le message qui correspond à l’identificateur de corrélation donné et déclenche immédiatement une exception si aucun message avec l’identificateur de corrélation spécifié existe actuellement dans la file d’attente.

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

Paramètres

correlationId
String

CorrelationId du message à recevoir.

transactionType
MessageQueueTransactionType

Une des valeurs MessageQueueTransactionType, décrivant le type de contexte de transaction à associer au message.

Retours

Message

Message dont CorrelationId correspond au paramètre de correlationId passé.

Exceptions

ArgumentNullException

Le paramètre correlationId est null.

InvalidOperationException

Impossible de trouver le message avec le correlationId spécifié.

InvalidEnumArgumentException

Le paramètre transactionType n’est pas l’un des membres MessageQueueTransactionType.

MessageQueueException

Une erreur s’est produite lors de l’accès à une méthode Message Queuing.

Exemples

L’exemple de code suivant illustre l’utilisation de 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);

Remarques

Cette méthode recherche dans la file d’attente référencée par l'MessageQueue un message dont CorrelationId correspond au paramètre correlationId spécifié. Si aucun message ne correspond au paramètre correlationID, une exception est levée. Sinon, le message est supprimé de la file d’attente et renvoyé à l’application à l’aide d’un contexte de transaction défini par le paramètre transactionType.

Spécifiez Automatic pour le paramètre transactionType s’il existe déjà un contexte de transaction externe attaché au thread que vous souhaitez utiliser pour recevoir le message. Spécifiez Single si vous souhaitez recevoir le message en tant que transaction interne unique. Vous pouvez spécifier None si vous souhaitez recevoir un message d’une file d’attente transactionnelle en dehors d’un contexte de transaction.

Si cette méthode est appelée pour recevoir un message d’une file d’attente transactionnelle, le message reçu est retourné à la file d’attente si la transaction est abandonnée. Le message n’est pas supprimé définitivement de la file d’attente tant que la transaction n’est pas validée.

La propriété CorrelationId est utilisée pour lier un message envoyé à la file d’attente aux messages de réponse, de rapport ou d’accusé de réception associés.

Deux autres méthodes vous permettent de recevoir des messages d’une file d’attente. La méthode Receive retourne le premier message dans la file d’attente, et la méthode ReceiveById(String) est utilisée pour récupérer un message en spécifiant son identificateur unique.

Pour lire un message avec un identificateur de corrélation spécifié sans le supprimer de la file d’attente, utilisez la méthode PeekByCorrelationId(String). La méthode PeekByCorrelationId(String) retourne toujours le premier message dans la file d’attente, de sorte que les appels suivants à la méthode retournent le même message, sauf si un message de priorité supérieure arrive dans la file d’attente. Aucun contexte de transaction n’est associé à un message retourné par un appel à PeekByCorrelationId(String). Étant donné que PeekByCorrelationId(String) ne supprime aucun message dans la file d’attente, il n’y aurait rien à restaurer si la transaction a été abandonnée.

Le tableau suivant indique si cette méthode est disponible dans différents modes de groupe de travail.

Mode groupe de travail Disponible
Ordinateur local Oui
Ordinateur local et nom de format direct Oui
Ordinateur distant Non
Ordinateur distant et nom de format direct Oui

Voir aussi

S’applique à

ReceiveByCorrelationId(String, MessageQueueTransaction)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente transactionnelle) et déclenche immédiatement une exception si aucun message avec l’identificateur de corrélation spécifié existe actuellement dans la file d’attente.

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

Paramètres

correlationId
String

CorrelationId du message à recevoir.

transaction
MessageQueueTransaction

Objet MessageQueueTransaction.

Retours

Message

Message dont CorrelationId correspond au paramètre de correlationId passé.

Exceptions

ArgumentNullException

Le paramètre correlationId est null.

-ou-

Le paramètre transaction est null.

InvalidOperationException

Impossible de trouver le message avec le correlationId spécifié.

MessageQueueException

La file d’attente n’est pas transactionnelle.

-ou-

Une erreur s’est produite lors de l’accès à une méthode Message Queuing.

Exemples

L’exemple de code suivant illustre l’utilisation de 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);

Remarques

Cette méthode recherche dans la file d’attente transactionnelle référencée par l'MessageQueue un message dont CorrelationId correspond au paramètre correlationId spécifié. Si aucun message ne correspond au paramètre correlationID, une exception est levée. Sinon, le message est supprimé de la file d’attente et renvoyé à l’application à l’aide du contexte de transaction interne défini par le paramètre transaction.

Étant donné que cette méthode est appelée sur une file d’attente transactionnelle, le message reçu est retourné à la file d’attente si la transaction est abandonnée. Le message n’est pas supprimé définitivement de la file d’attente tant que la transaction n’est pas validée.

La propriété CorrelationId est utilisée pour lier un message envoyé à la file d’attente aux messages de réponse, de rapport ou d’accusé de réception associés.

Deux autres méthodes vous permettent de recevoir des messages d’une file d’attente. La méthode Receive retourne le premier message dans la file d’attente, et la méthode ReceiveById(String) est utilisée pour récupérer un message en spécifiant son identificateur unique.

Pour lire un message avec un identificateur de corrélation spécifié sans le supprimer de la file d’attente, utilisez la méthode PeekByCorrelationId(String). La méthode PeekByCorrelationId(String) retourne toujours le premier message dans la file d’attente, de sorte que les appels suivants à la méthode retournent le même message, sauf si un message de priorité supérieure arrive dans la file d’attente. Aucun contexte de transaction n’est associé à un message retourné par un appel à PeekByCorrelationId(String). Étant donné que PeekByCorrelationId(String) ne supprime aucun message dans la file d’attente, il n’y aurait rien à restaurer si la transaction a été abandonnée.

Le tableau suivant indique si cette méthode est disponible dans différents modes de groupe de travail.

Mode groupe de travail Disponible
Ordinateur local Oui
Ordinateur local et nom de format direct Oui
Ordinateur distant Non
Ordinateur distant et nom de format direct Oui

Voir aussi

S’applique à

ReceiveByCorrelationId(String)

Reçoit le message qui correspond à l’identificateur de corrélation donné (à partir d’une file d’attente non transactionnelle) et déclenche immédiatement une exception si aucun message avec l’identificateur de corrélation spécifié existe actuellement dans la file d’attente.

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

Paramètres

correlationId
String

CorrelationId du message à recevoir.

Retours

Message

Message dont CorrelationId correspond au paramètre de correlationId passé.

Exceptions

ArgumentNullException

Le paramètre correlationId est null.

InvalidOperationException

Impossible de trouver le message avec le correlationId spécifié.

MessageQueueException

Une erreur s’est produite lors de l’accès à une méthode Message Queuing.

Exemples

L’exemple de code suivant envoie et reçoit un message qui contient une commande vers et depuis une file d’attente. Il demande spécifiquement un accusé de réception positif lorsque le message d’origine atteint ou est récupéré à partir de la file d’attente.

#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

Remarques

Cette méthode examine la file d’attente non transactionnelle référencée par l'MessageQueue pour un message dont CorrelationId correspond au paramètre de correlationId spécifié. Si aucun message ne correspond au paramètre correlationID, une exception est levée. Sinon, le message est supprimé de la file d’attente et renvoyé à l’application.

La propriété CorrelationId est utilisée pour lier un message envoyé à la file d’attente aux messages de réponse, de rapport ou d’accusé de réception associés.

Deux autres méthodes vous permettent de recevoir des messages d’une file d’attente. La méthode Receive retourne le premier message dans la file d’attente, et la méthode ReceiveById(String) récupère un message en spécifiant son identificateur unique.

Pour lire un message avec un identificateur de corrélation spécifié sans le supprimer de la file d’attente, utilisez la méthode PeekByCorrelationId(String). La méthode PeekByCorrelationId(String) retourne toujours le premier message dans la file d’attente, de sorte que les appels suivants à la méthode retournent le même message, sauf si un message de priorité supérieure arrive dans la file d’attente.

Le tableau suivant indique si cette méthode est disponible dans différents modes de groupe de travail.

Mode groupe de travail Disponible
Ordinateur local Oui
Ordinateur local et nom de format direct Oui
Ordinateur distant Non
Ordinateur distant et nom de format direct Oui

Voir aussi

S’applique à