Data.Cloud.AzureAPI.TAzureBlobService.GetBlobMetadata

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetBlobMetadata(ContainerName, BlobName: string; out Metadata: TStrings;  const Snapshot: string = ''; const LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): Boolean;

C++

bool __fastcall GetBlobMetadata(System::UnicodeString ContainerName, System::UnicodeString BlobName, /* out */ System::Classes::TStrings* &Metadata, const System::UnicodeString Snapshot = System::UnicodeString(), const 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

Gets the metadata for a given blob.

GetBlobMetadata gets the metadata for a given blob.

LeaseId is only required if it is the blob (not a snapshot) you are interested in, and if that blob is currently locked. In no other situation should you specify a value other than empty string for LeaseId, otherwise the request will fail.

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 metadata for.

Metadata

The returned metadata, or nil if the request fails.

Snapshot

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

LeaseId

The LeaseId, required if the blob is locked.

ResponseInfo

The optional class for storing response info into.

The method returns True if the call executes successfully, and False otherwise.

See Also