Data.Cloud.AzureAPI.TAzureBlobService.SetBlobMetadata
Delphi
function SetBlobMetadata(ContainerName, BlobName: string; Metadata: TStrings; LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function SetBlobMetadata(const AContainerName, ABlobName: string; AMetadata: array of TPair<string, string>; const ALeaseId: string; const AResponseInfo: TCloudResponseInfo): Boolean; overload;
C++
bool __fastcall SetBlobMetadata _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, System::Classes::TStrings* Metadata, System::UnicodeString LeaseId = System::UnicodeString(), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall SetBlobMetadata(const System::UnicodeString AContainerName, const System::UnicodeString ABlobName, System::Generics::Collections::TPair__2<System::UnicodeString,System::UnicodeString> *AMetadata, const int AMetadata_High, const System::UnicodeString ALeaseId, 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 given metadata for the specified blob.
SetBlobMetadata is used to set the metadata for a specified blob.
The following table describes the parameters:
| Parameter | Description |
|---|---|
|
|
The name of the container the blob is in. |
|
|
The name of the blob to get the properties for. |
|
|
The returned properties, or nil if the request fails. |
|
|
The snapshot identifier, if you are interested in a snapshot of the blob. |
|
|
The Lease ID, required if the blob is locked. |
|
|
The optional class for storing response info into. |
LeaseId should not be an empty string if the blob is locked. SetBlobMetadata replaces the full set of metadata currently on the blob; it does not append to it. Updating the metadata of a snapshot is not supported.
The method returns True if the action was successful, and False otherwise.