Data.Cloud.AzureAPI.TAzureBlobService.ReleaseContainerLease

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 ReleaseContainerLease(const AContainerName: string; var ALeaseId: string): Boolean; overload; deprecated 'Use overloaded method instead';
function ReleaseContainerLease(const AContainerName: string; var ALeaseId: string;
const AResponseInfo: TCloudResponseInfo): Boolean; overload;

C++

bool __fastcall ReleaseContainerLease _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (const System::UnicodeString AContainerName, System::UnicodeString &ALeaseId)/* overload */;
bool __fastcall ReleaseContainerLease(const System::UnicodeString AContainerName, System::UnicodeString &ALeaseId, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;

Description

Attempts to release the lease (lock for delete operations) with the specified identifier from the specified container, so that other clients can acquire a lease on that container.

ReleaseContainerLease accepts the following parameters:

  • ContainerName is the name of the target container.
  • LeaseId must be the GUID that is the identifier of the current lease on the specified container.
  • ResponseInfo is an optional instance of TCloudResponseInfo to store the information of the response.

ReleaseContainerLease returns True if the lease ID is released or False otherwise.

See Also