Data.Cloud.AzureAPI.TAzureBlobService.GetPageRegionsXML

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetPageRegionsXML(ContainerName, BlobName: string; StartByte, EndByte: Int64;  const Snapshot: string = ''; const LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): string; overload; deprecated 'Use GetPageRanges method instead';
function GetPageRegionsXML(ContainerName, BlobName: string;  const Snapshot: string = ''; const LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): string; overload; deprecated 'Use GetPageRanges method instead';

C++

System::UnicodeString __fastcall GetPageRegionsXML _DEPRECATED_ATTRIBUTE1("Use GetPageRanges method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, __int64 StartByte, __int64 EndByte, const System::UnicodeString Snapshot = System::UnicodeString(), const System::UnicodeString LeaseId = System::UnicodeString(), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
System::UnicodeString __fastcall GetPageRegionsXML _DEPRECATED_ATTRIBUTE1("Use GetPageRanges method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, const System::UnicodeString Snapshot = System::UnicodeString(), const System::UnicodeString LeaseId = System::UnicodeString(), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Data.Cloud.AzureAPI TAzureBlobService

Description

Warning: GetPageRegionsXML is deprecated. Please use GetPageRanges.

Returns the page regions for the given page blob in XML representation.

GetPageRegionsXML returns the page regions for the given page blob in XML representation.

There are two overloaded GetPageRegionsXML methods:

  • The first overloaded method returns the page regions in a range (StartByte/EndByte pairs). If the bytes are set to zero, then the whole page blob will be analyzed, otherwise only the given range will be analyzed.
  • The second overloaded method analyzes the whole page blob; same as calling fist overloaded method, where StartByte and EndByte of the range are set to zero.


The following table describes the parameters:

Parameter Description

ContainerName

The name of the container the blob is in.

BlobName

The name of the page blob.

StartByte

The start byte in the range to check for valid pages.

EndByte

The end byte in the range to check for valid pages.

Snapshot

The optional snapshot ID if you want to check one of the blob's snapshots.

LeaseId

The lease ID, required if the blob is locked.

ResponseInfo

The optional class for storing response info into.


See Also