Data.Cloud.AzureAPI.TAzureBlobService.SetContainerMetadata

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

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

C++

bool __fastcall SetContainerMetadata _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::Classes::TStrings* const Metadata, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall SetContainerMetadata(const System::UnicodeString AContainerName, System::Generics::Collections::TPair__2<System::UnicodeString,System::UnicodeString> *AMetadata, const int AMetadata_High, 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

Sets the metadata for the specified container.

SetContainerMetadata is used to set the metadata for the specified container.

The following table describes the parameters:

Parameter Description

ContainerName

The name of the container to set the metadata for.

Metadata

The metadata to set for the container.

ResponseInfo

The optional class for storing response info into.

Warning: Note that SetContainerMetadata replaces any existing metadata values. If you do not want to lose any of the metadata already on the container, be sure to include them in the Metadata passed in to this call.

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

See Also