Data.Cloud.AzureAPI.TAzureBlobService.BreakBlobLease

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function BreakBlobLease(ContainerName, BlobName: string; out LeaseTimeRemaining: Integer): Boolean; overload; deprecated 'Use overloaded method instead';
function BreakBlobLease(const AContainerName, ABlobName: string; out ALeaseTimeRemaining: Integer;  const AResponseInfo: TCloudResponseInfo): Boolean; overload;

C++

bool __fastcall BreakBlobLease _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName, /* out */ int &LeaseTimeRemaining)/* overload */;
bool __fastcall BreakBlobLease(const System::UnicodeString AContainerName, const System::UnicodeString ABlobName, /* out */ int &ALeaseTimeRemaining, 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

Breaks a previously acquired lease, without specifying the LeaseId.

BreakBlobLease releases a lease that was previously acquired. Calling this method is similar to calling ReleaseBlobLease, but because the LeaseId is not specified, the lease is allowed to expire before a new lease can be acquired. In this period, the lease is not able to be renewed.

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 release the lease for.

LeaseTimeRemaining

The number of seconds remaining until the lease expires.

ResponseInfo

The optional class for storing response info into.

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

See Also