Data.Cloud.AzureAPI.TAzureBlobService.GetBlobSnapshot

• Up to Parent: TAzureBlobService

Delphi

function GetBlobSnapshot(ContainerName, BlobName, Snapshot: string; SnapshotStream: TStream;
ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function GetBlobSnapshot(ContainerName, BlobName, Snapshot: string; SnapshotStream: TStream;
out Properties, Metadata: TStrings;
ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function GetBlobSnapshot(ContainerName, BlobName, Snapshot: string; SnapshotStream: TStream;
StartByte: int64 = 0; EndByte: int64 = 0;
GetAsHash: Boolean = False;
ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function GetBlobSnapshot(ContainerName, BlobName, Snapshot: string; SnapshotStream: TStream;
out Properties, Metadata: TStrings;
StartByte: int64 = 0; EndByte: int64 = 0;
GetAsHash: Boolean = False;
ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function GetBlobSnapshot(const AContainerName, ABlobName, ASnapshot, ALeaseId: string; AStartByte, AEndByte: Int64;
AGetAsHash: Boolean; out AProperties, AMetadata: TArray<TPair<string, string>>; out ASnapshotStream: TStream;
const AResponseInfo: TCloudResponseInfo): Boolean; overload;

C++

bool __fastcall GetBlobSnapshot _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, System::UnicodeString Snapshot, System::Classes::TStream* SnapshotStream, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall GetBlobSnapshot _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, System::UnicodeString Snapshot, System::Classes::TStream* SnapshotStream, /* out */ System::Classes::TStrings* &Properties, /* out */ System::Classes::TStrings* &Metadata, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall GetBlobSnapshot _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, System::UnicodeString Snapshot, System::Classes::TStream* SnapshotStream, __int64 StartByte = 0LL, __int64 EndByte = 0LL, bool GetAsHash = false, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall GetBlobSnapshot _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, System::UnicodeString Snapshot, System::Classes::TStream* SnapshotStream, /* out */ System::Classes::TStrings* &Properties, /* out */ System::Classes::TStrings* &Metadata, __int64 StartByte = 0LL, __int64 EndByte = 0LL, bool GetAsHash = false, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall GetBlobSnapshot(const System::UnicodeString AContainerName, const System::UnicodeString ABlobName, const System::UnicodeString ASnapshot, const System::UnicodeString ALeaseId, __int64 AStartByte, __int64 AEndByte, bool AGetAsHash, /* out */ System::DynamicArray<System::Generics::Collections::TPair__2<System::UnicodeString,System::UnicodeString> > &AProperties, /* out */ System::DynamicArray<System::Generics::Collections::TPair__2<System::UnicodeString,System::UnicodeString> > &AMetadata, /* out */ System::Classes::TStream* &ASnapshotStream, 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

Downloads the given snapshot, writing its content into the provided stream.

GetBlobSnapshot downloads the given snapshot, writing its content into the provided stream.

There are 4 overloaded GetBlobSnapshot methods.

The second overloaded method also returns the snapshot's properties and metadata.

Using the third overloaded method, you can request only a range of the blob to be returned by specifying values for StartByte and EndByte. If you specify a range, you can also set GetAsHash to True, which will return the MD5 hash of the range's content, instead of the content itself. Note that you can only return the hash for a range, and not the full content.

The fourth overloaded method also returns the snapshot's properties and metadata; you can request only a range of the blob to be returned by specifying values for StartByte and EndByte, similarly to the third overloaded method.

The following table describes the parameters for all four overloaded methods:

Parameter	Description
ContainerName	The name of the container the blob is in.
BlobName	The name of the blob the snapshot is for.
Snapshot	The snapshot to get.
SnapshotStream	The stream to write the snapshot content into.
StartByte	The starting byte index.
EndByte	The ending byte index, or 0 if you do not want a range of the snapshot.
GetAsHash	If True or if EndByte is greater than StartByte, the method returns content as MD5 hash.
Properties	The blob's property name/value pairs.
Metadata	The blob's metadata name/value pairs.
LeaseId	The lease ID, required if the blob is locked.
ResponseInfo	The optional class for storing response info into.

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

See Also

• System.Classes.TStream

• DeleteBlob

• GetBlob