Data.Cloud.AzureAPI.TAzureBlobService.AcquireContainerLease

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function AcquireContainerLease(const ContainerName: string; var LeaseId: string; LeaseDuration: Integer;  ResponseInfo: TCloudResponseInfo): Boolean;

C++

bool __fastcall AcquireContainerLease(const System::UnicodeString ContainerName, System::UnicodeString &LeaseId, int LeaseDuration, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo);

プロパティ

種類 可視性 ソース ユニット
function public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Data.Cloud.AzureAPI TAzureBlobService


説明

指定されたコンテナでリース(削除オペレーション用のロック)の取得を、指定された時間の間、試みます。

AcquireContainerLease は、次のパラメータを取ります:

  • ContainerName は、ターゲット コンテナの名前です。
  • LeaseId は、新しいリースのための識別子として提示する 有効な GUID でなければなりません。 提示された GUID が使用されない場合、AcquireContainerLeaseLeaseId の値を、代わりに使用された GUID に変更します。リースの取得に失敗した場合、AcquireContainerLease は、空の文字列で LeaseId を埋めます。
    メモ: ChangeContainerLeaseReleaseContainerLease、または RenewContainerLease を呼び出すには、LeaseId の値が必要です。
  • LeaseDuration は、リースの希望する時間です。有効な値は -1(期限なし)、または 15 ~ 60 の範囲での秒数です。
  • ResponseInfo は、レスポンスの情報を格納する TCloudResponseInfo の任意のインスタンスです。 レスポンスの情報が必要ない場合には nil 値を使用します。

AcquireContainerLease は、リースが取得された場合には True を、そうでなければ False を返します。

関連項目