Data.Cloud.AzureAPI.TAzureBlobService.ListContainers
Delphi
function ListContainers(out NextMarker: string; OptionalParams: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): TList<TAzureContainer>; overload; deprecated 'Use overloaded method instead';
function ListContainers(OptionalParams: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): TList<TAzureContainer>; overload; deprecated 'Use overloaded method instead';
function ListContainers(AIncludeMetadata: Boolean; const APrefix: string; const AMarker: string; AMaxResult: Integer; out ANextMarker: string; out AResponseXML: string; const AResponseInfo: TCloudResponseInfo): TArray<TAzureContainerItem>; overload;
C++
System::Generics::Collections::TList__1<TAzureContainer*>* __fastcall ListContainers _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (/* out */ System::UnicodeString &NextMarker, System::Classes::TStrings* OptionalParams = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
System::Generics::Collections::TList__1<TAzureContainer*>* __fastcall ListContainers _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::Classes::TStrings* OptionalParams = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
System::DynamicArray<TAzureContainerItem> __fastcall ListContainers(bool AIncludeMetadata, const System::UnicodeString APrefix, const System::UnicodeString AMarker, int AMaxResult, /* out */ System::UnicodeString &ANextMarker, /* out */ System::UnicodeString &AResponseXML, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.Cloud.AzureAPI.pas Data.Cloud.AzureAPI.hpp |
Data.Cloud.AzureAPI | TAzureBlobService |
Description
Returns the containers available on the blob service account.
ListContainers is used to return the containers available on the blob service account.
There are two overloaded ListContainers methods. The following table describes the parameters:
| Parameter | Description |
|---|---|
|
|
Will be set to the 'NextMarker' returned from the request, or to an empty string. |
|
|
The optional parameters for the call. |
|
|
The optional class for storing response info into. |
Supported optional parameters are: prefix, marker, maxresults, include=metadata.
If prefix is set, its value is set as being the prefix a container name needs to start with in order to be included in the list of containers returned by this call.
If marker is set, then it is used as a continuation token, which indicates to the container the position at which to start the listing. The value for this continuation token is specified in the NextMarker element of the XML returned.
If maxresults is specified, it is treated as an integer in the range from 1 through 5000. This represents the maximum number of containers to return with this call.
If include is set with a value of metadata, then the metadata for each container is also returned.