Data.Cloud.AmazonAPI.TAmazonStorageService.DeleteBucket

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: public
Source:
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Unit: Data.Cloud.AmazonAPI
Parent: TAmazonStorageService

Delphi

function DeleteBucket(const BucketName: string;
ResponseInfo: TCloudResponseInfo = nil;
const BucketRegion: TAmazonRegion = amzrNotSpecified): Boolean;

C++

bool __fastcall DeleteBucket(const System::UnicodeString BucketName, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), const TAmazonRegion BucketRegion = System::UnicodeString());

Description

Deletes a bucket.

DeleteBucket accepts the following parameters:

  • BucketName: The name of the bucket to delete.
  • ResponseInfo: Optional. Holds the response information.
  • BucketRegion: Optional. The region of the bucket to delete. Default is amzrNotSpecified, which means that this method automatically detects the region of the bucket based on the name of the bucket.

The method returns True if the deletion succeeds, False otherwise.

See Also