Data.Cloud.AzureAPI.TAzureBlobService.RenewContainerLease

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 RenewContainerLease(const AContainerName: string; var ALeaseId: string;
const AResponseInfo: TCloudResponseInfo): Boolean;

C++

bool __fastcall RenewContainerLease(const System::UnicodeString AContainerName, System::UnicodeString &ALeaseId, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo);

Description

Attempts to renew the lease (lock for delete operations) with the specified identifier on the specified container.

RenewContainerLease 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.

RenewContainerLease returns True if the lease ID is released or False otherwise. Use a nil value if you do not need the information of the response.

See Also