Data.Cloud.AzureAPI.TAzureQueueService.ListQueuesXML
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));
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Description
Lists the queues currently available in the queue service account as an XML string.
ListQueuesXML is used to list the queues currently available in the queue service account as an XML string.
The following table shows the significance of the parameters:
| Parameter | Description |
|---|---|
|
OptionalParams |
The optional parameters to use in the query. |
|
ResponseInfo |
The optional class for storing response info into. |
The supported optional parameters are: prefix, maxresults, and include = metadata.
The prefix parameter has a value that is the prefix a queue name must start with for the queue to be included in the list of queues returned by this request.
The maxresults parameter takes an integer value that specifies how many queues to return. If this is not specified, up to 5000 queues will be returned.
If the include parameter is specified with a value of metadata, then metadata corresponding to each queue will be returned in the XML.