MessageQueue.GetAllMessages Méthode
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Retourne tous les messages qui figurent dans la file d'attente.
public:
cli::array <System::Messaging::Message ^> ^ GetAllMessages();
public System.Messaging.Message[] GetAllMessages ();
member this.GetAllMessages : unit -> System.Messaging.Message[]
Public Function GetAllMessages () As Message()
Retours
Tableau de type Message qui représente tous les messages de la file d'attente, dans le même ordre que celui qui est utilisé dans la file d'attente Message Queuing.
Exceptions
Une erreur s'est produite lors de l'accès à une méthode Message Queuing.
Exemples
L'exemple de code suivant montre l'utilisation de GetAllMessages.
// Connect to a queue on the local computer.
MessageQueue^ queue = gcnew MessageQueue(".\\exampleQueue");
// Populate an array with copies of all the messages in the queue.
array<Message^>^ msgs = queue->GetAllMessages();
// Loop through the messages.
for each(Message^ msg in msgs)
{
// Display the label of each message.
Console::WriteLine(msg->Label);
}
queue->Close();
// Connect to a queue on the local computer.
MessageQueue queue = new MessageQueue(".\\exampleQueue");
// Populate an array with copies of all the messages in the queue.
Message[] msgs = queue.GetAllMessages();
// Loop through the messages.
foreach(Message msg in msgs)
{
// Display the label of each message.
Console.WriteLine(msg.Label);
}
Remarques
GetAllMessagesretourne une instantané statique des messages dans la file d’attente, et non des liens dynamiques vers ces messages. Par conséquent, vous ne pouvez pas utiliser le tableau pour modifier les messages dans la file d’attente. Si vous souhaitez une interaction dynamique en temps réel avec la file d’attente (par exemple, la possibilité de supprimer des messages), appelez la GetMessageEnumerator2 méthode, qui retourne une liste dynamique des messages dans la file d’attente.
Étant donné que GetAllMessages retourne une copie des messages dans la file d’attente au moment où la méthode a été appelée, le tableau ne reflète pas les nouveaux messages qui arrivent dans la file d’attente ou les messages supprimés de la file d’attente.
GetAllMessages récupère uniquement les propriétés non filtrées par la MessageReadPropertyFilter propriété .
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 |