Data.Cloud.AmazonAPI.TAmazonStorageService.AbortMultipartUpload

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function AbortMultipartUpload(const BucketName, ObjectName, UploadId: string;
ResponseInfo: TCloudResponseInfo = nil;
const BucketRegion: TAmazonRegion = amzrNotSpecified): Boolean;

C++

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

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonStorageService

Description

Aborts a previously initiated multipart upload.

All storage consumed by previously uploaded parts for this multipart upload is freed. However, if there are any in-progress part uploads for this UploadId when you abort it, then the part may be uploaded successfully and you would then be required to abort the UploadId again to free any additional parts.

The method returns True if successful, and False otherwise.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The bucket the multipart upload object was to be stored.

ObjectName

The name of the object that would have resulted from the multipart upload.

UploadId

The UploadId originally returned when the multipart upload was initiated.

ResponseInfo

The optional class for storing response info into.

See Also