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));
Eigenschaften
Typ | Sichtbarkeit | Quelle | Unit | Übergeordnet |
---|---|---|---|---|
function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Beschreibung
Gibt die Nachrichten aus der angegebenen Queue in XML-Repräsentation zurück.
Mit PeekMessagesXML werden die Nachrichten aus der angegebenen Queue mit keinem Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt-Wert ermittelt. Die Methode gibt das Ergebnis in XML-Repräsentation zurück.
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 |
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.
Der Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt-Wert wird für von diesem Aufruf zurückgegebenen Nachrichten nicht angegeben. Es gibt keine in VisibilityTimeout
angegebene Zeitüberschreitung der Sichtbarkeit, daher können Nachrichten von anderen Benutzern sofort abgefragt und angezeigt werden.