Data.Cloud.AzureAPI.TAzureBlobService.ChangeContainerLease

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 ChangeContainerLease(const AContainerName: string; var ALeaseID: string; const AProposedLeaseID: string;
const AResponseInfo: TCloudResponseInfo): Boolean;

C++

bool __fastcall ChangeContainerLease(const System::UnicodeString AContainerName, System::UnicodeString &ALeaseID, const System::UnicodeString AProposedLeaseID, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo);

Description

Attempts to change the identifier of a lease (lock for delete operations) on the specified container.

ChangeContainerLease 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. If the proposed GUID (ProposedLeaseID) is used, ChangeContainerLease changes the value of LeaseId to the new GUID.
  • 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.

ChangeContainerLease returns True if the lease ID is modified or False otherwise.

See Also