Data.Cloud.AzureAPI.TAzureBlobService.DeleteBlob

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function DeleteBlob(ContainerName, BlobName: string): Boolean; overload; deprecated 'Use overloaded method instead';
function DeleteBlob(const AContainerName, ABlobName: string; AOnlySnapshots: Boolean; const ALeaseId: string;  const AResponseInfo: TCloudResponseInfo): Boolean; overload;

C++

bool __fastcall DeleteBlob _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::UnicodeString BlobName)/* overload */;
bool __fastcall DeleteBlob(const System::UnicodeString AContainerName, const System::UnicodeString ABlobName, bool AOnlySnapshots, const System::UnicodeString ALeaseId, Data::Cloud::Cloudapi::TCloudResponseInfo* const AResponseInfo)/* overload */;

Properties

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

Description

Deletes the specified blob, or deletes all of its snapshots.

DeleteBlob deletes the specified blob if OnlySnapshots is False, or deletes only the blob's snapshots if OnlySnapShot is True.

The following table describes the parameters:

Parameter Description

ContainerName

The name of the container the blob is in.

BlobName

The name of the blob to delete.

OnlySnapshots

Set to True to delete all of the blob's snapshots, but not the blob.

LeaseId

The LeaseId, required if the blob is locked.

ResponseInfo

The optional class for storing response info into.


The method returns True if the blob is deleted successfully, False otherwise.


See Also