Data.Cloud.AzureAPI.TAzureBlobService.ClearPage

From RAD Studio API Documentation
Jump to: navigation, search

Delphi 

function ClearPage(ContainerName, BlobName: string; StartPage, PageCount: Integer;  const LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function ClearPage(ContainerName, BlobName: string; StartPage, PageCount: Integer;  ActionConditional: TBlobActionConditional; const LeaseId: string = ''; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated 'Use overloaded method instead';
function ClearPage(const AContainerName, ABlobName, ALeaseID: string; AStartPage, APageCount: Integer;  AActionConditional: TBlobActionConditional; const AResponseInfo: TCloudResponseInfo): Boolean; overload;

C++ 

bool __fastcall ClearPage _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, int StartPage, int PageCount, const System::UnicodeString LeaseId = System::UnicodeString(), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall ClearPage _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, int StartPage, int PageCount, const TBlobActionConditional &ActionConditional, const System::UnicodeString LeaseId = System::UnicodeString(), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall ClearPage(const System::UnicodeString AContainerName, const System::UnicodeString ABlobName, const System::UnicodeString ALeaseID, int AStartPage, int APageCount, const TBlobActionConditional &AActionConditional, 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

Clears the specified range and releases the space used for storage for that range.

ClearPage is used to clear the specified range and releases the spaced used for storage for that range.

There are two overloaded ClearPage methods. For the second overloaded method, the supported action conditionals include:

  • IfModifiedSince
  • IfUnmodifiedSince
  • IfMatch
  • IfNoneMatch
  • if-sequence-number-lte
  • if-sequence-number-lt
  • if-sequence-number-eq

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.

StartPage

The zero-based index of the first page this action applies to.

PageCount

The number of pages this action applies to.

ActionConditional

Conditions that must be met for the action to be executed.

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 action is successful, and False otherwise.

See Also

Retrieved from "http://docwiki.embarcadero.com/Libraries/Rio/e/index.php?title=Data.Cloud.AzureAPI.TAzureBlobService.ClearPage&oldid=725969"