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));
Eigenschaften
| Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Beschreibung
Gibt die XML-Repräsentation der Nachrichten zurück.
Mit GetMessagesXML wird die XML-Repräsentation der Nachrichten aus der angegebenen Queue ermittelt.
Die folgende Tabelle gibt die Bedeutung der Parameter an:
| Parameter | Beschreibung |
|---|---|
|
QueueName |
Der Name der Queue, für die die Nachrichten ermittelt werden sollen |
|
NumOfMessages |
Die maximale Anzahl der NAchrichteb, die zurückgegeben werden sollen |
|
VisibilityTimeout |
Zeitspanne, die die Nachrichten reserviert werden sollten |
|
ResponseInfo |
Die optionale Klasse zum Speichern der Antwortinformationen |
Ist NumOfMessages nicht gesetzt, wird der Vorgabewert des Servers (1) verwendet. Der zulässige Maximalwert ist 32.
Ist VisibilityTimeout nicht gesetzt, wird der Vorgabewert des Servers (30 Sekunden) verwendet. Der zulässige Maximalwert ist 2 Stunden.
Für die von diesem Aufruf zurückgegebenen Nachrichten wird der Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt-Wert angegeben. Dieser Wert gilt während der in VisibilityTimeout angegebenen Zeitspanne als eindeutiges Token der Nachricht, das zum Löschen der Nachricht verwendet werden kann.