Data.Cloud.AzureAPI.TAzureBlobService.GetBlobProperties

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetBlobProperties(ContainerName, BlobName: string; out Properties: TStrings;  const Snapshot: string = ''; const LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function GetBlobProperties(ContainerName, BlobName: string; out Properties: TStrings;  out Metadata: TStrings; const Snapshot: string = ''; const LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function GetBlobProperties(const AContainerName, ABlobName, ALeaseId, ASnapshot: string;  const AResponseInfo: TCloudResponseInfo): TArray<TPair<string, string>>; overload;

C++

bool __fastcall GetBlobProperties _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, /* out */ System::Classes::TStrings* &Properties, const System::UnicodeString Snapshot = System::UnicodeString(), const System::UnicodeString LeaseId = System::UnicodeString(), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall GetBlobProperties _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, /* out */ System::Classes::TStrings* &Properties, /* 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))/* overload */;
System::DynamicArray<System::Generics::Collections::TPair__2<System::UnicodeString,System::UnicodeString> > __fastcall GetBlobProperties(const System::UnicodeString AContainerName, const System::UnicodeString ABlobName, const System::UnicodeString ALeaseId, const System::UnicodeString ASnapshot, 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

Gets the properties for a given blob.

GetBlobProperties is used to get the properties 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.

There are two overloaded GetBlobProperties methods. The second one also returns the Metadata of the 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.

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 population was successful, and False otherwise.

See Also