Data.Cloud.AmazonAPI.TAmazonQueueService.GetMessagesXML

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function GetMessagesXML(const QueueURL: string;  NumOfMessages: Integer = 0; VisibilityTimeout: Integer = -1; ResponseInfo: TCloudResponseInfo = nil): string; deprecated;

C++

System::UnicodeString __fastcall GetMessagesXML _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, int NumOfMessages = 0x0, int VisibilityTimeout = 0xffffffff, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));

Eigenschaften

Typ Sichtbarkeit Quelle Unit Übergeordnet
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonQueueService


Beschreibung

Gibt die Nachrichten aus der angegebenen Queue zurück.

Wenn NumOfMessages nicht gesetzt ist, wird der Standardwert des Servers (1) verwendet. Der maximal zulässige Wert ist 10. Wenn VisibilityTimeout nicht gesetzt ist, wird der Standardwert der Queue verwendet. Der maximal zulässige Wert ist 12 Stunden. Für die von diesem Aufruf zurückgegebenen Nachrichten ist der jeweilige Pop-Empfang (PopReceipt) angegeben. Dieser ist das eindeutige Token der Nachricht während der in VisibilityTimeout angegebenen Zeitüberschreitung, das zum Löschen der Nachricht verwendet werden kann.

Mit GetMessagesXML wird die XML-Repräsentation der Nachricht zurückgegeben.

Die folgende Tabelle gibt die Bedeutung der Parameter an:

Parameter Beschreibung

QueueURL

Der URL der Queue, für die die Nachrichten ermittelt werden sollen.

NumOfMessages

Die maximale Anzahl der Nachrichten, die zurückgegeben werden sollen.

VisibilityTimeout

Die Zeitdauer, für die die Nachrichten reserviert werden sollen.

ResponseInfo

Die optionale Klasse zum Speichern von Antwortinformationen.

Siehe auch