Data.Cloud.AzureAPI.TAzureQueueService.GetMessages
Delphi
function GetMessages(const QueueName: string; NumOfMessages: Integer = 0; VisibilityTimeout: Integer = 0; ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueueMessage>;
C++
System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueueMessage*>* __fastcall GetMessages(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 Nachrichten aus der angegebenen Queue zurück.
Mit GetMessages werden 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 Nachrichten, 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. Während der in VisibilityTimeout angegebenen Zeitspanne werden die Nachrichten vor allen weiteren Nachrichtenabfragen verborgen.
Die Methode gibt die Liste der Nachrichten mit den enthaltenen Pop-Empfängen zurück.