Data.Cloud.AzureAPI.TAzureQueueService.PeekMessages

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function PeekMessages(const QueueName: string; NumOfMessages: Integer;
ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueueMessage>;

C++

System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueueMessage*>* __fastcall PeekMessages(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 Nachrichten aus der angegebenen Queue zurück.

Mit PeekMessages werden Nachrichten aus der angegebenen Queue mit keinem angegebenen Data.Cloud.CloudAPI.TCloudQueueMessage.PopReceipt-Wert 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 Nachrichtenn, 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.

Siehe auch