Data.Cloud.AzureAPI.TAzureBlobService.SetBlobMetadata

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function SetBlobMetadata(ContainerName, BlobName: string; Metadata: TStrings; LeaseId: string = '';  ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

bool __fastcall SetBlobMetadata(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));

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

ContainerName

The name of the container the blob is in.

BlobName

The name of the blob to get the properties for.

Properties

The returned properties, or nil if the request fails.

Snapshot

The snapshot identifier, if you are interested in a snapshot of the blob.

LeaseId

The Lease ID, required if the blob is locked.

ResponseInfo

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.


See Also