Data.Cloud.AzureAPI.TAzureQueueService.PeekMessagesXML
Delphi
function PeekMessagesXML(const QueueName: string; NumOfMessages: Integer;
ResponseInfo: TCloudResponseInfo = nil): string;
C++
System::UnicodeString __fastcall PeekMessagesXML(const System::UnicodeString QueueName, int NumOfMessages, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Description
Renvoie des messages de la file d'attente donnée dans une représentation XML.
Utilisez PeekMessagesXML pour obtenir des messages de la file d'attente donnée, sans leur Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt. La méthode renvoie le résultat dans une représentation XML.
Le tableau suivant indique la signification des paramètres :
Paramètre | Description |
---|---|
QueueName |
Le nom de la file d'attente pour laquelle obtenir des messages. |
NumOfMessages |
Le nombre maximal de messages à renvoyer. |
ResponseInfo |
La classe optionnelle dans laquelle stocker les informations de la réponse. |
Si NumOfMessages
n'est pas défini, la valeur par défaut 1 du serveur est utilisée. La valeur maximale autorisée est 32.
Notez que les messages renvoyés par cet appel n'auront pas leur Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt spécifié. Il n'y a aucun délai d'attente de la visibilité (VisibilityTimeout
) ; ainsi, d'autres utilisateurs peuvent demander et visualiser instantanément des messages.