Data.Cloud.AzureAPI.TAzureBlobService.CopyBlob

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function CopyBlob(TargetContainerName, TargetBlobName, SourceContainerName, SourceBlobName: string;  const TargetLeaseId: string = ''; Metadata: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;
function CopyBlob(TargetContainerName, TargetBlobName, SourceContainerName, SourceBlobName: string;  CopyConditionals: TBlobActionConditional; const TargetLeaseId: string = ''; Metadata: TStrings = nil; ResponseInfo: TCloudResponseInfo = nil): Boolean; overload;

C++

bool __fastcall CopyBlob(System::UnicodeString TargetContainerName, System::UnicodeString TargetBlobName, System::UnicodeString SourceContainerName, System::UnicodeString SourceBlobName, const System::UnicodeString TargetLeaseId = System::UnicodeString(), System::Classes::TStrings* Metadata = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall CopyBlob(System::UnicodeString TargetContainerName, System::UnicodeString TargetBlobName, System::UnicodeString SourceContainerName, System::UnicodeString SourceBlobName, const TBlobActionConditional &CopyConditionals, const System::UnicodeString TargetLeaseId = System::UnicodeString(), System::Classes::TStrings* Metadata = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Data.Cloud.AzureAPI TAzureBlobService

Description

Copies the specified blob to the given target location.

CopyBlob copies the specified blob to the given target location.

If a blob exists at the target location, the content will be replaced. If metadata is specified, then the target blob will have that metadata, otherwise, it will have the metadata that exists on the source blob.

There are two overloaded CopyBlob methods. The following table shows the significance of the parameters:

Parameter Description

TargetContainerName

The container to put the copied blob into.

TargetBlobName

The name of the resulting blob.

SourceContainerName

The container the blob being copied is in.

SourceBlobName

The name of the blob being copied.

CopyConditionals

The conditions to meet in order to perform the copying.

TargetLeaseId

The lease ID, required if the target blob already exists and is locked.

Metadata

The optional metadata to use on the target, instead of the source's.

ResponseInfo

The optional class for storing response info into.


The method returns True if the copying was successful, False otherwise.


See Also