Data.Cloud.AmazonAPI.TAmazonQueueService.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.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonQueueService

Description

Lists the queues currently available in the queue service account.

The supported optional parameter is QueueNamePrefix. The QueueNamePrefix parameter has a value that is the prefix a queue name must start with in order to be included in the list of queues returned by this request.

ListQueues returns the list of queues, or an empty list.

The following table shows the significance of the parameters:

Parameter Description

OptionalParams

Optional parameters to use in the query.

ResponseInfo

The optional class for storing response info into.

See Also