Data.Cloud.AzureAPI.TAzureQueueService.GetMessagesXML
Delphi
function GetMessagesXML(const QueueName: string; NumOfMessages: Integer = 0; VisibilityTimeout: Integer = 0; ResponseInfo: TCloudResponseInfo = nil): string;
C++
System::UnicodeString __fastcall GetMessagesXML(const System::UnicodeString QueueName, int NumOfMessages = 0x0, int VisibilityTimeout = 0x0, 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 la représentation XML des messages.
Utilisez GetMessagesXML pour obtenir la représentation XML des messages depuis la file d'attente donnée.
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. |
|
VisibilityTimeout |
La délai de réservation des messages. |
|
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.
Si VisibilityTimeout n'est pas défini, la valeur par défaut du serveur (30 secondes) est utilisée. La valeur maximale autorisée est de 2 heures.
Notez que les messages renvoyés par cet appel auront leur Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt spécifié, qui est un jeton unique au message pendant le délai d'attente de la visibilité (VisibilityTimeout) pouvant être utilisé pour supprimer le message.