Data.Cloud.AmazonAPI.TAmazonStorageService.InitiateMultipartUploadXML

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function InitiateMultipartUploadXML(const BucketName, ObjectName: string; Metadata: TStrings = nil;  Headers: TStrings = nil; ACL: TAmazonACLType = amzbaPrivate; ResponseInfo: TCloudResponseInfo = nil; BucketRegion: TAmazonRegion = amzrNotSpecified): string;

C++

System::UnicodeString __fastcall InitiateMultipartUploadXML(const System::UnicodeString BucketName, const System::UnicodeString ObjectName, System::Classes::TStrings* Metadata = (System::Classes::TStrings*)(0x0), System::Classes::TStrings* Headers = (System::Classes::TStrings*)(0x0), TAmazonACLType ACL = (TAmazonACLType)(0x1), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0), TAmazonRegion BucketRegion = (TAmazonRegion)(0x0));

Properties

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

Description

Starts a new multipart upload.

The returned XML contains the UploadId. This is required for future calls to UploadPart, or for stopping or canceling the multipart upload. There are several supported optional headers. For a list of them and their functionality, go to the Amazon documentation.

InitiateMultipartUploadXML returns the XML representation that contains the UploadId to use for subsequent calls.

The following table shows the significance of the parameters:

Parameter Description

BucketName

The name of the bucket the object will be in.

ObjectName

The name of the object this multipart upload will create.

Metadata

The metadata to set on the resulting object, or nil.

Headers

Optional headers to set.

ACL

Optional ACL to set on the resulting object. Default is amzbaPrivate.

ResponseInfo

The optional class for storing response info into.

See Also