Data.Cloud.AzureAPI.TAzureQueueService.ListQueues

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function ListQueues(OptionalParams: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueue>;

C++

System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueue>* __fastcall ListQueues(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.

ListQueues is used to list the queues currently available in the queue service account.

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.

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.

The method returns the list of queues, or an empty list.

See Also