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));
Propriétés
Type | Visibilité | Source | Unité | Parent |
---|---|---|---|---|
function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureQueueService |
Description
Liste les files d'attente actuellement disponibles dans le compte de service des files d'attente en tant que chaîne XML.
ListQueuesXML est utilisée pour lister les files d'attente actuellement disponibles dans le compte de service des files d'attente en tant que chaîne XML.
Le tableau suivant indique la signification des paramètres :
Paramètre | Description |
---|---|
OptionalParams |
Les paramètres optionnels à utiliser dans la requête. |
ResponseInfo |
La classe optionnelle dans laquelle stocker les informations de la réponse. |
Les paramètres optionnels supportés sont : prefix
, maxresults
et include = metadata
.
Le paramètre prefix
a une valeur représentant le préfixe par lequel le nom d'une file d'attente doit commencer pour que la file d'attente soit incluse dans la liste de files d'attente renvoyées par cette requête.
Le paramètre maxresults
prend une valeur entière qui spécifie le nombre de files d'attente à renvoyer. S'il n'est pas spécifié, un nombre maximal de 5000 files d'attente seront renvoyées.
Si le paramètre include
est spécifié avec une valeur de metadata
, les métadonnées correspondant à chaque file d'attente sont renvoyées dans la chaîne XML.