DSAzure.TAzureQueueService.ListQueues

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function ListQueues(params: array of const; values: array of const): String;

C++

System::UnicodeString __fastcall ListQueues(System::TVarRec *params, const int params_High, System::TVarRec *values, const int values_High);

Properties

Type Visibility Source Unit Parent
function public
DSAzure.pas
DSAzure.hpp
DSAzure TAzureQueueService

Description

Retrieves a list of queues from the server.

ListQueues retrieves a list of queues from the server. The params and values arrays contain any optional parameters you want to send with the request. For example, if you wanted the queues to be returned along with any metadata they may have assigned to them, you could call:

ListQueues(['include'], ['metadata']);

The first array contains the parameter names and the second array (which should always be the same length as the first array) contains the values. In the example above, it is the same as specifying the request parameter include=metadata. For a full list of supported parameters, see the MSDN documentation listed below.

This call returns an XML string that contains the list of queues. For more information on this XML format, see the MSDN documentation or the Microsoft Azure Queue API in the See Also section.

See Also