Data.Cloud.AzureAPI.TAzureBlobService.BreakContainerLease

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Unit: Data.Cloud.AzureAPI
Parent: TAzureBlobService

Delphi 

function BreakContainerLease(const AContainerName: string; out ALeaseTimeRemaining: Integer;
const AResponseInfo: TCloudResponseInfo): Boolean;

C++ 

bool __fastcall BreakContainerLease(const System::UnicodeString AContainerName, /* out */ int &ALeaseTimeRemaining, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo);

Description

Ends the current lease (lock for delete operations) on the specified container and ensures that no other client can acquire a new lease until the period of the current lease has expired.

BreakContainerLease accepts the following parameters:

  • ContainerName is the name of the target container.
  • LeaseTimeRemaining, which BreakContainerLease fills with the number of seconds remaining until a client can create a new lease on the specified container.
  • ResponseInfo is an optional instance of TCloudResponseInfo to store the information of the response. Use a nil value if you do not need the information of the response.

BreakContainerLease returns True if the lease is successfully broken or False otherwise.

See Also

Retrieved from "https://docwiki.embarcadero.com/Libraries/Florence/e/index.php?title=Data.Cloud.AzureAPI.TAzureBlobService.BreakContainerLease&oldid=748820"