Data.Cloud.AzureAPI.TAzureBlobService.GetContainerMetadata

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Unit: Data.Cloud.AzureAPI
Parent: TAzureBlobService

Delphi

function GetContainerMetadata(ContainerName: string; out Metadata: TStrings;
ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function GetContainerMetadata(const AContainerName: string;
const AResponseInfo: TCloudResponseInfo): TArray<TPair<string, string>>; overload;

C++

bool __fastcall GetContainerMetadata _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, /* out */ System::Classes::TStrings* &Metadata, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
System::DynamicArray<System::Generics::Collections::TPair__2<System::UnicodeString,System::UnicodeString> > __fastcall GetContainerMetadata(const System::UnicodeString AContainerName, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;

Description

Returns the metadata for the container with the given name.

GetContainerMetadata is used to return the metadata for the container with the given name.

The following table describes the parameters:

Parameter Description

ContainerName

The name of the container to get the metadata for.

Metadata

The outputted metadata, or an empty list.

ResponseInfo

The optional class for storing response info into.

The method returns True if the population was successful, and False otherwise.

See Also