Data.Cloud.AmazonAPI.TAmazonStorageService.GetBucketVersioning

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 GetBucketVersioning(const BucketName: string;
ResponseInfo: TCloudResponseInfo = nil;
const BucketRegion: TAmazonRegion = amzrNotSpecified): Boolean;

C++

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

Description

Returns the state of versioning for the specified bucket.

GetBucketVersioning returns True if versioning is enabled for the given bucket, and False otherwise. If False is returned, then either versioning is suspended, or it has never been enabled.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The name of the bucket to get the versioning state for.

ResponseInfo

The optional class for storing response info into.

See Also