Data.Cloud.AzureAPI.TAzureQueueService.ListQueuesXML

Aus RAD Studio API Documentation
Wechseln zu: Navigation, Suche

Delphi

function ListQueuesXML(OptionalParams: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): string;

C++

System::UnicodeString __fastcall ListQueuesXML(System::Classes::TStrings* OptionalParams = (System::Classes::TStrings*)(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

Führt die Queues auf, die aktuell im Queue-Dienstkonto als XML-String verfügbar sind.

Mit ListQueuesXML werden die Queues aufgeführt, die aktuell im Queue-Dienstkonto als XML-String verfügbar sind.

Die folgende Tabelle gibt die Bedeutung der Parameter an:

Parameter Beschreibung

OptionalParams

Die optionalen Parameter, die in der Abfrage verwendet werden sollen

ResponseInfo

Die optionale Klasse zum Speichern der Antwortinformationen


Die unterstützten optionalen Parameter sind: prefix, maxresults und include = metadata.

Der Parameter prefix ist das Präfix, mit dem der Name einer Queue beginnen muss, damit die Queue in die Liste der von dieser Anforderung zurückgegebenen Queues einbezogen wird.

Der Parameter maxresults übernimmt einen Integerwert, der angibt, wie viele Queues zurückgegeben werden sollen. Falls nicht angegeben, werden bis zu 5000 Queues zurückgegeben.

Wenn der Parameter include mit einem Wert von metadata angegeben wird, werden die Metadaten, die jeder beliebigen Queue entsprechen, im XML zurückgegeben.


Siehe auch