AmazonS3 Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonS3 class provides an easy way to interface with Amazon's Simple Storage Service (S3).

Syntax

AmazonS3

Remarks

The AmazonS3 class allows you to access Amazon's Simple Storage Service (S3) in a secure manner using TLS/SSL. S3 allows you to store arbitrary data objects on Amazon's server and access them from anywhere using an Internet connection. There are features available to authenticate access to private objects, share objects as public, distribute an object using Bittorrent etc. A brief synopsis follows but please refer to Amazon S3 documentation for details.

You will first need to sign up for the S3 service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.

There are other methods such as ListBuckets, ListObjects, GetObject, GetLink, DeleteObject etc. that further enable you to manage your S3 data store.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccessKey Property (AmazonS3 Class)

The access key to use for authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccessKey();
int SetAccessKey(const char* lpszAccessKey);

Unicode (Windows)
LPWSTR GetAccessKey();
INT SetAccessKey(LPCWSTR lpszAccessKey);

char* cloudstorage_amazons3_getaccesskey(void* lpObj);
int cloudstorage_amazons3_setaccesskey(void* lpObj, const char* lpszAccessKey);

QString GetAccessKey();
int SetAccessKey(QString qsAccessKey);

Default Value

""

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

AccessPolicy Property (AmazonS3 Class)

The canned access policy to apply to a bucket or object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAccessPolicy();
int SetAccessPolicy(int iAccessPolicy);

Unicode (Windows)
INT GetAccessPolicy();
INT SetAccessPolicy(INT iAccessPolicy);

PT_PRIVATE(0), 
PT_PUBLIC_READ(1), 
PT_PUBLIC_READ_WRITE(2), 
PT_AUTHENTICATED_READ(3), 
PT_BUCKET_OWNER_READ(4), 
PT_BUCKET_OWNER_FULL_CONTROL(5), 
PT_NONE(6)

int cloudstorage_amazons3_getaccesspolicy(void* lpObj);
int cloudstorage_amazons3_setaccesspolicy(void* lpObj, int iAccessPolicy);

int GetAccessPolicy();
int SetAccessPolicy(int iAccessPolicy);

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

• CopyObject (for the destination object)
• CreateBucket
• CreateObject
• StartMultipartUpload
• UpdateBucketACL
• UpdateObjectACL

Valid values are:

Data Type

Integer

Bucket Property (AmazonS3 Class)

Selects a bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBucket();
int SetBucket(const char* lpszBucket);

Unicode (Windows)
LPWSTR GetBucket();
INT SetBucket(LPCWSTR lpszBucket);

char* cloudstorage_amazons3_getbucket(void* lpObj);
int cloudstorage_amazons3_setbucket(void* lpObj, const char* lpszBucket);

QString GetBucket();
int SetBucket(QString qsBucket);

Default Value

""

Remarks

This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations.

Data Type

String

Buckets Property (AmazonS3 Class)

A collection of buckets.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageS3Bucket>* GetBuckets();

int cloudstorage_amazons3_getbucketscount(void* lpObj);

char* cloudstorage_amazons3_getbucketscreationdate(void* lpObj, int bucketsindex);

char* cloudstorage_amazons3_getbucketsname(void* lpObj, int bucketsindex);

char* cloudstorage_amazons3_getbucketsownerdisplayname(void* lpObj, int bucketsindex);

char* cloudstorage_amazons3_getbucketsownerid(void* lpObj, int bucketsindex);

int GetBucketsCount();

QString GetBucketsCreationDate(int iBucketsIndex);

QString GetBucketsName(int iBucketsIndex);

QString GetBucketsOwnerDisplayName(int iBucketsIndex);

QString GetBucketsOwnerId(int iBucketsIndex);

Remarks

This collection holds a list of S3Bucket items.

Calling ListBuckets will populate this collection.

This property is read-only and not available at design time.

Data Type

CloudStorageS3Bucket

ContentDisposition Property (AmazonS3 Class)

Content disposition to send for an object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentDisposition();
int SetContentDisposition(const char* lpszContentDisposition);

Unicode (Windows)
LPWSTR GetContentDisposition();
INT SetContentDisposition(LPCWSTR lpszContentDisposition);

char* cloudstorage_amazons3_getcontentdisposition(void* lpObj);
int cloudstorage_amazons3_setcontentdisposition(void* lpObj, const char* lpszContentDisposition);

QString GetContentDisposition();
int SetContentDisposition(QString qsContentDisposition);

Default Value

""

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server anytime the object is downloaded.

This property is not available at design time.

Data Type

String

ContentType Property (AmazonS3 Class)

Content type to send for an object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentType();
int SetContentType(const char* lpszContentType);

Unicode (Windows)
LPWSTR GetContentType();
INT SetContentType(LPCWSTR lpszContentType);

char* cloudstorage_amazons3_getcontenttype(void* lpObj);
int cloudstorage_amazons3_setcontenttype(void* lpObj, const char* lpszContentType);

QString GetContentType();
int SetContentType(QString qsContentType);

Default Value

""

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server anytime the object is downloaded.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (AmazonS3 Class)

The encryption algorithm.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Unicode (Windows)
INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

EA_AES(0), 
EA_BLOWFISH(1), 
EA_CAST(2), 
EA_DES(3), 
EA_IDEA(4), 
EA_RC2(5), 
EA_RC4(6), 
EA_TEA(7), 
EA_TRIPLE_DES(8), 
EA_TWOFISH(9), 
EA_RIJNDAEL(10), 
EA_CHA_CHA(11), 
EA_XSALSA_20(12)

int cloudstorage_amazons3_getencryptionalgorithm(void* lpObj);
int cloudstorage_amazons3_setencryptionalgorithm(void* lpObj, int iEncryptionAlgorithm);

int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm);

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (AmazonS3 Class)

The encryption password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword);

Unicode (Windows)
LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);

char* cloudstorage_amazons3_getencryptionpassword(void* lpObj);
int cloudstorage_amazons3_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

QString GetEncryptionPassword();
int SetEncryptionPassword(QString qsEncryptionPassword);

Default Value

""

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

Firewall Property (AmazonS3 Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

CloudStorageFirewall* GetFirewall();
int SetFirewall(CloudStorageFirewall* val);

int cloudstorage_amazons3_getfirewallautodetect(void* lpObj);
int cloudstorage_amazons3_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudstorage_amazons3_getfirewalltype(void* lpObj);
int cloudstorage_amazons3_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudstorage_amazons3_getfirewallhost(void* lpObj);
int cloudstorage_amazons3_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudstorage_amazons3_getfirewallpassword(void* lpObj);
int cloudstorage_amazons3_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudstorage_amazons3_getfirewallport(void* lpObj);
int cloudstorage_amazons3_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudstorage_amazons3_getfirewalluser(void* lpObj);
int cloudstorage_amazons3_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

CloudStorageFirewall

FollowRedirects Property (AmazonS3 Class)

Determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Unicode (Windows)
INT GetFollowRedirects();
INT SetFollowRedirects(INT iFollowRedirects);

FR_NEVER(0), 
FR_ALWAYS(1), 
FR_SAME_SCHEME(2)

int cloudstorage_amazons3_getfollowredirects(void* lpObj);
int cloudstorage_amazons3_setfollowredirects(void* lpObj, int iFollowRedirects);

int GetFollowRedirects();
int SetFollowRedirects(int iFollowRedirects);

Default Value

0

Remarks

This property specifies how the class should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are:

Data Type

Integer

Idle Property (AmazonS3 Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_amazons3_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (AmazonS3 Class)

The location of the local file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalFile();
wchar_t* GetLocalFile_W(); // Windows only
int SetLocalFile(const char* lpszLocalFile);
int SetLocalFile(const wchar_t* lpszLocalFile); // Windows only

Unicode (Windows)
LPWSTR GetLocalFile();
INT SetLocalFile(LPCWSTR lpszLocalFile);

char* cloudstorage_amazons3_getlocalfile(void* lpObj);
wchar_t* cloudstorage_amazons3_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_amazons3_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_amazons3_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

QString GetLocalFile();
int SetLocalFile(QString qsLocalFile);

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.

Note: Setting this property to a non-empty value will discard any streams set using SetDownloadStream and SetUploadStream. Similarly, passing a non-null value to either of the aforementioned methods will clear this property.

Data Type

String

LocalHost Property (AmazonS3 Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost);

Unicode (Windows)
LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);

char* cloudstorage_amazons3_getlocalhost(void* lpObj);
int cloudstorage_amazons3_setlocalhost(void* lpObj, const char* lpszLocalHost);

QString GetLocalHost();
int SetLocalHost(QString qsLocalHost);

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

Metadata Property (AmazonS3 Class)

A collection of metadata items.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageS3Metadata>* GetMetadata();
int SetMetadata(CloudStorageList<CloudStorageS3Metadata>* val);

int cloudstorage_amazons3_getmetadatacount(void* lpObj);
int cloudstorage_amazons3_setmetadatacount(void* lpObj, int iMetadataCount);

char* cloudstorage_amazons3_getmetadataname(void* lpObj, int metadataindex);
int cloudstorage_amazons3_setmetadataname(void* lpObj, int metadataindex, const char* lpszMetadataName);

char* cloudstorage_amazons3_getmetadatavalue(void* lpObj, int metadataindex);
int cloudstorage_amazons3_setmetadatavalue(void* lpObj, int metadataindex, const char* lpszMetadataValue);

int GetMetadataCount();
int SetMetadataCount(int iMetadataCount);

QString GetMetadataName(int iMetadataIndex);
int SetMetadataName(int iMetadataIndex, QString qsMetadataName);

QString GetMetadataValue(int iMetadataIndex);
int SetMetadataValue(int iMetadataIndex, QString qsMetadataValue);

Remarks

This collection holds a list of S3Metadata items.

This collection is populated when GetObjectInfo is called; and its items are used anytime CreateObject, CopyObject, or StartMultipartUpload is called.

This property is not available at design time.

Data Type

CloudStorageS3Metadata

ObjectData Property (AmazonS3 Class)

The data that was downloaded, or that should be uploaded.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjectData(char* &lpObjectData, int &lenObjectData);
int SetObjectData(const char* lpObjectData, int lenObjectData);

Unicode (Windows)
INT GetObjectData(LPSTR &lpObjectData, INT &lenObjectData);
INT SetObjectData(LPCSTR lpObjectData, INT lenObjectData);

int cloudstorage_amazons3_getobjectdata(void* lpObj, char** lpObjectData, int* lenObjectData);
int cloudstorage_amazons3_setobjectdata(void* lpObj, const char* lpObjectData, int lenObjectData);

QByteArray GetObjectData();
int SetObjectData(QByteArray qbaObjectData);

Default Value

""

Remarks

This property is populated with object data after calling GetObject if SetDownloadStream and LocalFile are not set.

This property can also be set before calling CreateObject or UploadPart; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

Data Type

Binary String

ObjectDelimiter Property (AmazonS3 Class)

The delimiter string to use when listing objects.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectDelimiter();
int SetObjectDelimiter(const char* lpszObjectDelimiter);

Unicode (Windows)
LPWSTR GetObjectDelimiter();
INT SetObjectDelimiter(LPCWSTR lpszObjectDelimiter);

char* cloudstorage_amazons3_getobjectdelimiter(void* lpObj);
int cloudstorage_amazons3_setobjectdelimiter(void* lpObj, const char* lpszObjectDelimiter);

QString GetObjectDelimiter();
int SetObjectDelimiter(QString qsObjectDelimiter);

Default Value

""

Remarks

If this property is non-empty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual objects themselves.

The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class will also populate the PrefixCount and Prefix[i] configuration settings

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

ObjectMarker Property (AmazonS3 Class)

A marker indicating what page of objects to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectMarker();
int SetObjectMarker(const char* lpszObjectMarker);

Unicode (Windows)
LPWSTR GetObjectMarker();
INT SetObjectMarker(LPCWSTR lpszObjectMarker);

char* cloudstorage_amazons3_getobjectmarker(void* lpObj);
int cloudstorage_amazons3_setobjectmarker(void* lpObj, const char* lpszObjectMarker);

QString GetObjectMarker();
int SetObjectMarker(QString qsObjectMarker);

Default Value

""

Remarks

This property will be populated when ListObjects is called if the results are paged and there are more pages. To list all objects, continue to call ListObjects until this property returns empty string.

Refer to ListObjects for more information.

This property is not available at design time.

Data Type

String

ObjectPrefix Property (AmazonS3 Class)

A prefix used to restrict the results returned when listing objects.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectPrefix();
int SetObjectPrefix(const char* lpszObjectPrefix);

Unicode (Windows)
LPWSTR GetObjectPrefix();
INT SetObjectPrefix(LPCWSTR lpszObjectPrefix);

char* cloudstorage_amazons3_getobjectprefix(void* lpObj);
int cloudstorage_amazons3_setobjectprefix(void* lpObj, const char* lpszObjectPrefix);

QString GetObjectPrefix();
int SetObjectPrefix(QString qsObjectPrefix);

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by ListObjects (or ListVersions) to only the objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

Objects Property (AmazonS3 Class)

A collection of objects.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageS3Object>* GetObjects();

int cloudstorage_amazons3_getobjectscount(void* lpObj);

int cloudstorage_amazons3_getobjectsdeleted(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectsetag(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectslastmodified(void* lpObj, int objectsindex);

int cloudstorage_amazons3_getobjectslatestversion(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectsname(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectsownerdisplayname(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectsownerid(void* lpObj, int objectsindex);

int64 cloudstorage_amazons3_getobjectssize(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectsstorageclass(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectsuploadid(void* lpObj, int objectsindex);

char* cloudstorage_amazons3_getobjectsversionid(void* lpObj, int objectsindex);

int GetObjectsCount();

bool GetObjectsDeleted(int iObjectsIndex);

QString GetObjectsETag(int iObjectsIndex);

QString GetObjectsLastModified(int iObjectsIndex);

bool GetObjectsLatestVersion(int iObjectsIndex);

QString GetObjectsName(int iObjectsIndex);

QString GetObjectsOwnerDisplayName(int iObjectsIndex);

QString GetObjectsOwnerId(int iObjectsIndex);

qint64 GetObjectsSize(int iObjectsIndex);

QString GetObjectsStorageClass(int iObjectsIndex);

QString GetObjectsUploadId(int iObjectsIndex);

QString GetObjectsVersionId(int iObjectsIndex);

Remarks

This collection holds a list of S3Object items.

Calling GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads will populate this collection.

This property is read-only and not available at design time.

Data Type

CloudStorageS3Object

OtherHeaders Property (AmazonS3 Class)

Other headers as determined by the user (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOtherHeaders();
int SetOtherHeaders(const char* lpszOtherHeaders);

Unicode (Windows)
LPWSTR GetOtherHeaders();
INT SetOtherHeaders(LPCWSTR lpszOtherHeaders);

char* cloudstorage_amazons3_getotherheaders(void* lpObj);
int cloudstorage_amazons3_setotherheaders(void* lpObj, const char* lpszOtherHeaders);

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (AmazonS3 Class)

Determines if local files are overwritten.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int cloudstorage_amazons3_getoverwrite(void* lpObj);
int cloudstorage_amazons3_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property controls whether local files are overwritten when calling GetObject. It is only applicable to local files. The default value is false.

Data Type

Boolean

ParsedHeaders Property (AmazonS3 Class)

This property includes a collection of headers returned from the last request.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageHeader>* GetParsedHeaders();

int cloudstorage_amazons3_getparsedheadercount(void* lpObj);

char* cloudstorage_amazons3_getparsedheaderfield(void* lpObj, int parsedheaderindex);

char* cloudstorage_amazons3_getparsedheadervalue(void* lpObj, int parsedheaderindex);

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

This property contains a collection of headers returned from the last request. Whenever headers are returned from the server, the headers are parsed into a collection of headers. Each Header in this collection contains information describing that header.

MaxHeaders can be used to control the maximum number of headers saved.

This property is read-only and not available at design time.

Data Type

CloudStorageHeader

PartMarker Property (AmazonS3 Class)

A marker indicating what page of parts to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartMarker();
int SetPartMarker(const char* lpszPartMarker);

Unicode (Windows)
LPWSTR GetPartMarker();
INT SetPartMarker(LPCWSTR lpszPartMarker);

char* cloudstorage_amazons3_getpartmarker(void* lpObj);
int cloudstorage_amazons3_setpartmarker(void* lpObj, const char* lpszPartMarker);

QString GetPartMarker();
int SetPartMarker(QString qsPartMarker);

Default Value

""

Remarks

This property will be populated when ListParts is called if the results are paged and there are more pages. To list all parts, continue to call ListParts until this property returns empty string.

Refer to ListParts for more information.

This property is not available at design time.

Data Type

String

Parts Property (AmazonS3 Class)

A collection of multipart upload parts.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageS3Part>* GetParts();

int cloudstorage_amazons3_getpartscount(void* lpObj);

char* cloudstorage_amazons3_getpartsetag(void* lpObj, int partsindex);

char* cloudstorage_amazons3_getpartslastmodified(void* lpObj, int partsindex);

char* cloudstorage_amazons3_getpartsobjectname(void* lpObj, int partsindex);

char* cloudstorage_amazons3_getpartsownerdisplayname(void* lpObj, int partsindex);

char* cloudstorage_amazons3_getpartsownerid(void* lpObj, int partsindex);

int cloudstorage_amazons3_getpartsnumber(void* lpObj, int partsindex);

int64 cloudstorage_amazons3_getpartssize(void* lpObj, int partsindex);

int GetPartsCount();

QString GetPartsETag(int iPartsIndex);

QString GetPartsLastModified(int iPartsIndex);

QString GetPartsObjectName(int iPartsIndex);

QString GetPartsOwnerDisplayName(int iPartsIndex);

QString GetPartsOwnerId(int iPartsIndex);

int GetPartsNumber(int iPartsIndex);

qint64 GetPartsSize(int iPartsIndex);

Remarks

This collection holds a list of S3Part items.

Calling ListParts will populate this collection.

This property is read-only and not available at design time.

Data Type

CloudStorageS3Part

Proxy Property (AmazonS3 Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

CloudStorageProxy* GetProxy();
int SetProxy(CloudStorageProxy* val);

int cloudstorage_amazons3_getproxyauthscheme(void* lpObj);
int cloudstorage_amazons3_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudstorage_amazons3_getproxyautodetect(void* lpObj);
int cloudstorage_amazons3_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudstorage_amazons3_getproxypassword(void* lpObj);
int cloudstorage_amazons3_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudstorage_amazons3_getproxyport(void* lpObj);
int cloudstorage_amazons3_setproxyport(void* lpObj, int iProxyPort);

char* cloudstorage_amazons3_getproxyserver(void* lpObj);
int cloudstorage_amazons3_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudstorage_amazons3_getproxyssl(void* lpObj);
int cloudstorage_amazons3_setproxyssl(void* lpObj, int iProxySSL);

char* cloudstorage_amazons3_getproxyuser(void* lpObj);
int cloudstorage_amazons3_setproxyuser(void* lpObj, const char* lpszProxyUser);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

CloudStorageProxy

QueryParams Property (AmazonS3 Class)

Additional query parameters to be included in the request.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageQueryParam>* GetQueryParams();
int SetQueryParams(CloudStorageList<CloudStorageQueryParam>* val);

int cloudstorage_amazons3_getqueryparamcount(void* lpObj);
int cloudstorage_amazons3_setqueryparamcount(void* lpObj, int iQueryParamCount);

char* cloudstorage_amazons3_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_amazons3_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

char* cloudstorage_amazons3_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_amazons3_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

QString GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, QString qsQueryParamName);

QString GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, QString qsQueryParamValue);

Remarks

This is a collection of query parameters that will be added to the request. Parameters can be added via the AddQueryParam method.

Data Type

CloudStorageQueryParam

Range Property (AmazonS3 Class)

The range of bytes to request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRange();
int SetRange(const char* lpszRange);

Unicode (Windows)
LPWSTR GetRange();
INT SetRange(LPCWSTR lpszRange);

char* cloudstorage_amazons3_getrange(void* lpObj);
int cloudstorage_amazons3_setrange(void* lpObj, const char* lpszRange);

QString GetRange();
int SetRange(QString qsRange);

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a GetObject request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when GetObject is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

This property is not available at design time.

Data Type

String

Region Property (AmazonS3 Class)

The region the class will make requests against.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRegion();
int SetRegion(const char* lpszRegion);

Unicode (Windows)
LPWSTR GetRegion();
INT SetRegion(LPCWSTR lpszRegion);

char* cloudstorage_amazons3_getregion(void* lpObj);
int cloudstorage_amazons3_setregion(void* lpObj, const char* lpszRegion);

QString GetRegion();
int SetRegion(QString qsRegion);

Default Value

"us-east-1"

Remarks

This property controls which region the class will make requests against. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed to create or access resources in other regions.

Regions:

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.

Data Type

String

SecretKey Property (AmazonS3 Class)

The secret key to use for authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSecretKey();
int SetSecretKey(const char* lpszSecretKey);

Unicode (Windows)
LPWSTR GetSecretKey();
INT SetSecretKey(LPCWSTR lpszSecretKey);

char* cloudstorage_amazons3_getsecretkey(void* lpObj);
int cloudstorage_amazons3_setsecretkey(void* lpObj, const char* lpszSecretKey);

QString GetSecretKey();
int SetSecretKey(QString qsSecretKey);

Default Value

""

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SSLAcceptServerCert Property (AmazonS3 Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(CloudStorageCertificate* val);

char* cloudstorage_amazons3_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertfingerprint(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertissuer(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertprivatekey(void* lpObj);

int cloudstorage_amazons3_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertpublickey(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_amazons3_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertserialnumber(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudstorage_amazons3_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudstorage_amazons3_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudstorage_amazons3_getsslacceptservercertstorepassword(void* lpObj);
int cloudstorage_amazons3_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudstorage_amazons3_getsslacceptservercertstoretype(void* lpObj);
int cloudstorage_amazons3_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudstorage_amazons3_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertusage(void* lpObj);

int cloudstorage_amazons3_getsslacceptservercertusageflags(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertversion(void* lpObj);

char* cloudstorage_amazons3_getsslacceptservercertsubject(void* lpObj);
int cloudstorage_amazons3_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudstorage_amazons3_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_amazons3_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

CloudStorageCertificate

SSLCert Property (AmazonS3 Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLCert();
int SetSSLCert(CloudStorageCertificate* val);

char* cloudstorage_amazons3_getsslcerteffectivedate(void* lpObj);

char* cloudstorage_amazons3_getsslcertexpirationdate(void* lpObj);

char* cloudstorage_amazons3_getsslcertextendedkeyusage(void* lpObj);

char* cloudstorage_amazons3_getsslcertfingerprint(void* lpObj);

char* cloudstorage_amazons3_getsslcertfingerprintsha1(void* lpObj);

char* cloudstorage_amazons3_getsslcertfingerprintsha256(void* lpObj);

char* cloudstorage_amazons3_getsslcertissuer(void* lpObj);

char* cloudstorage_amazons3_getsslcertprivatekey(void* lpObj);

int cloudstorage_amazons3_getsslcertprivatekeyavailable(void* lpObj);

char* cloudstorage_amazons3_getsslcertprivatekeycontainer(void* lpObj);

char* cloudstorage_amazons3_getsslcertpublickey(void* lpObj);

char* cloudstorage_amazons3_getsslcertpublickeyalgorithm(void* lpObj);

int cloudstorage_amazons3_getsslcertpublickeylength(void* lpObj);

char* cloudstorage_amazons3_getsslcertserialnumber(void* lpObj);

char* cloudstorage_amazons3_getsslcertsignaturealgorithm(void* lpObj);

int cloudstorage_amazons3_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_amazons3_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudstorage_amazons3_getsslcertstorepassword(void* lpObj);
int cloudstorage_amazons3_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudstorage_amazons3_getsslcertstoretype(void* lpObj);
int cloudstorage_amazons3_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudstorage_amazons3_getsslcertsubjectaltnames(void* lpObj);

char* cloudstorage_amazons3_getsslcertthumbprintmd5(void* lpObj);

char* cloudstorage_amazons3_getsslcertthumbprintsha1(void* lpObj);

char* cloudstorage_amazons3_getsslcertthumbprintsha256(void* lpObj);

char* cloudstorage_amazons3_getsslcertusage(void* lpObj);

int cloudstorage_amazons3_getsslcertusageflags(void* lpObj);

char* cloudstorage_amazons3_getsslcertversion(void* lpObj);

char* cloudstorage_amazons3_getsslcertsubject(void* lpObj);
int cloudstorage_amazons3_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudstorage_amazons3_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_amazons3_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

CloudStorageCertificate

SSLProvider Property (AmazonS3 Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int cloudstorage_amazons3_getsslprovider(void* lpObj);
int cloudstorage_amazons3_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCert Property (AmazonS3 Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLServerCert();

char* cloudstorage_amazons3_getsslservercerteffectivedate(void* lpObj);

char* cloudstorage_amazons3_getsslservercertexpirationdate(void* lpObj);

char* cloudstorage_amazons3_getsslservercertextendedkeyusage(void* lpObj);

char* cloudstorage_amazons3_getsslservercertfingerprint(void* lpObj);

char* cloudstorage_amazons3_getsslservercertfingerprintsha1(void* lpObj);

char* cloudstorage_amazons3_getsslservercertfingerprintsha256(void* lpObj);

char* cloudstorage_amazons3_getsslservercertissuer(void* lpObj);

char* cloudstorage_amazons3_getsslservercertprivatekey(void* lpObj);

int cloudstorage_amazons3_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_amazons3_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_amazons3_getsslservercertpublickey(void* lpObj);

char* cloudstorage_amazons3_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_amazons3_getsslservercertpublickeylength(void* lpObj);

char* cloudstorage_amazons3_getsslservercertserialnumber(void* lpObj);

char* cloudstorage_amazons3_getsslservercertsignaturealgorithm(void* lpObj);

int cloudstorage_amazons3_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* cloudstorage_amazons3_getsslservercertstorepassword(void* lpObj);

int cloudstorage_amazons3_getsslservercertstoretype(void* lpObj);

char* cloudstorage_amazons3_getsslservercertsubjectaltnames(void* lpObj);

char* cloudstorage_amazons3_getsslservercertthumbprintmd5(void* lpObj);

char* cloudstorage_amazons3_getsslservercertthumbprintsha1(void* lpObj);

char* cloudstorage_amazons3_getsslservercertthumbprintsha256(void* lpObj);

char* cloudstorage_amazons3_getsslservercertusage(void* lpObj);

int cloudstorage_amazons3_getsslservercertusageflags(void* lpObj);

char* cloudstorage_amazons3_getsslservercertversion(void* lpObj);

char* cloudstorage_amazons3_getsslservercertsubject(void* lpObj);

int cloudstorage_amazons3_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudStorageCertificate

StartByte Property (AmazonS3 Class)

The byte offset from which to resume the upload or download.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte);

Unicode (Windows)
LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);

int64 cloudstorage_amazons3_getstartbyte(void* lpObj);
int cloudstorage_amazons3_setstartbyte(void* lpObj, int64 lStartByte);

qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

Default Value

0

Remarks

This property specifies the byte offset from which to resume an automatic multipart upload initiated by CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.

When uploading from a stream, the class will always seek forward in the stream if the value of StartByte is greater than 0 when CreateObject is called. Keep this in mind when resuming interrupted object uploads.

This property is not available at design time.

Data Type

Long64

Timeout Property (AmazonS3 Class)

The timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int cloudstorage_amazons3_gettimeout(void* lpObj);
int cloudstorage_amazons3_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseSSL Property (AmazonS3 Class)

Whether to use SSL/TLS when connecting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseSSL();
int SetUseSSL(int bUseSSL);

Unicode (Windows)
BOOL GetUseSSL();
INT SetUseSSL(BOOL bUseSSL);

int cloudstorage_amazons3_getusessl(void* lpObj);
int cloudstorage_amazons3_setusessl(void* lpObj, int bUseSSL);

bool GetUseSSL();
int SetUseSSL(bool bUseSSL);

Default Value

TRUE

Remarks

This property specifies whether the class should use SSL/TLS when connecting.

This property is not available at design time.

Data Type

Boolean

UseVirtualHosting Property (AmazonS3 Class)

Determines which URL style to use when making requests.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUseVirtualHosting();
int SetUseVirtualHosting(int bUseVirtualHosting);

Unicode (Windows)
BOOL GetUseVirtualHosting();
INT SetUseVirtualHosting(BOOL bUseVirtualHosting);

int cloudstorage_amazons3_getusevirtualhosting(void* lpObj);
int cloudstorage_amazons3_setusevirtualhosting(void* lpObj, int bUseVirtualHosting);

bool GetUseVirtualHosting();
int SetUseVirtualHosting(bool bUseVirtualHosting);

Default Value

TRUE

Remarks

If true (default), virtual-hosted-style URLs will be used to make requests: http://yourbucket.s3.amazonaws.com/yourobject. Note that hosted-style URLs impose more bucket name restrictions due to DNS server naming restrictions. Refer to Amazon's documentation for more information.

If false, path-style URLs will be used to make requests: http://s3.amazonaws.com/yourbucket/yourobject.

Important: Amazon has publicly announced that buckets created after September 30, 2020 will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020 will continue to support both URL styles.

This property is not available at design time.

Data Type

Boolean

VersionId Property (AmazonS3 Class)

The object version to make requests against.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionId();
int SetVersionId(const char* lpszVersionId);

Unicode (Windows)
LPWSTR GetVersionId();
INT SetVersionId(LPCWSTR lpszVersionId);

char* cloudstorage_amazons3_getversionid(void* lpObj);
int cloudstorage_amazons3_setversionid(void* lpObj, const char* lpszVersionId);

QString GetVersionId();
int SetVersionId(QString qsVersionId);

Default Value

""

Remarks

This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:

• CopyObject (to copy from a specific object version)
• DeleteObject
• GetLink (to build a link for a specific object version)
• GetObject
• GetObjectInfo
• SendCustomRequest
• UpdateObjectACL

Refer to Amazon's Versioning documentation for more information about versioning.

This property is not available at design time.

Data Type

String

VersionMarker Property (AmazonS3 Class)

A marker indicating what page of object versions to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVersionMarker();
int SetVersionMarker(const char* lpszVersionMarker);

Unicode (Windows)
LPWSTR GetVersionMarker();
INT SetVersionMarker(LPCWSTR lpszVersionMarker);

char* cloudstorage_amazons3_getversionmarker(void* lpObj);
int cloudstorage_amazons3_setversionmarker(void* lpObj, const char* lpszVersionMarker);

QString GetVersionMarker();
int SetVersionMarker(QString qsVersionMarker);

Default Value

""

Remarks

This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AbortMultipartUpload Method (AmazonS3 Class)

Aborts a multipart upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AbortMultipartUpload(const char* lpszObjectName, const char* lpszUploadId);

Unicode (Windows)
INT AbortMultipartUpload(LPCWSTR lpszObjectName, LPCWSTR lpszUploadId);

int cloudstorage_amazons3_abortmultipartupload(void* lpObj, const char* lpszObjectName, const char* lpszUploadId);

int AbortMultipartUpload(const QString& qsObjectName, const QString& qsUploadId);

Remarks

This method aborts the multipart upload of the object named ObjectName specified by UploadId.

When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server. (Note that if any part uploads are currently in progress, it may be necessary to call this method again after they complete.)

If this method is called successfully, the specified UploadId will no longer be valid.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddMetadata Method (AmazonS3 Class)

Adds a metadata item to the Metadata properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddMetadata(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddMetadata(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudstorage_amazons3_addmetadata(void* lpObj, const char* lpszName, const char* lpszValue);

int AddMetadata(const QString& qsName, const QString& qsValue);

Remarks

This method adds a metadata item to the Metadata properties. Name specifies the name of the item, and Value specifies the value of the item. Keep in mind that the server stores metadata names in lowercase.

If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-, etc.), it will be stripped off. The class will take care of prepending it when sending metadata to the server.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AddQueryParam Method (AmazonS3 Class)

Adds a query parameter to the QueryParams properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddQueryParam(const char* lpszName, const char* lpszValue);

Unicode (Windows)
INT AddQueryParam(LPCWSTR lpszName, LPCWSTR lpszValue);

int cloudstorage_amazons3_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

int AddQueryParam(const QString& qsName, const QString& qsValue);

Remarks

This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

AppendObject Method (AmazonS3 Class)

This method appends data to the end of the existing object specified by ObjectName .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AppendObject(const char* lpszObjectName);

Unicode (Windows)
INT AppendObject(LPCWSTR lpszObjectName);

int cloudstorage_amazons3_appendobject(void* lpObj, const char* lpszObjectName);

int AppendObject(const QString& qsObjectName);

Remarks

The data to upload are taken from either the stream set using SetUploadStream or ObjectData (whichever data are found first, when checked in that order).

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BucketExists Method (AmazonS3 Class)

Checks whether the bucket exists.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool BucketExists();

Unicode (Windows)
INT BucketExists();

bool cloudstorage_amazons3_bucketexists(void* lpObj);

bool BucketExists();

Remarks

This method checks whether the bucket specified by Bucket exists, returning true if so or false if not.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CheckVersioningEnabled Method (AmazonS3 Class)

Checks whether versioning is enabled for the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
bool CheckVersioningEnabled();

Unicode (Windows)
INT CheckVersioningEnabled();

bool cloudstorage_amazons3_checkversioningenabled(void* lpObj);

bool CheckVersioningEnabled();

Remarks

This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this method will always return false when queried.

Refer to Amazon's Versioning documentation for more information about versioning.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CompleteMultipartUpload Method (AmazonS3 Class)

Completes a multipart upload by assembling previously uploaded parts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CompleteMultipartUpload(const char* lpszObjectName, const char* lpszUploadId);

Unicode (Windows)
INT CompleteMultipartUpload(LPCWSTR lpszObjectName, LPCWSTR lpszUploadId);

int cloudstorage_amazons3_completemultipartupload(void* lpObj, const char* lpszObjectName, const char* lpszUploadId);

int CompleteMultipartUpload(const QString& qsObjectName, const QString& qsUploadId);

Remarks

This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.

Note that this method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts properties, nor does it cause the PartList event to fire.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (AmazonS3 Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* cloudstorage_amazons3_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

CopyObject Method (AmazonS3 Class)

Copies an object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CopyObject(const char* lpszSrcObjectName, const char* lpszDestBucket, const char* lpszDestObjectName);

Unicode (Windows)
INT CopyObject(LPCWSTR lpszSrcObjectName, LPCWSTR lpszDestBucket, LPCWSTR lpszDestObjectName);

int cloudstorage_amazons3_copyobject(void* lpObj, const char* lpszSrcObjectName, const char* lpszDestBucket, const char* lpszDestObjectName);

int CopyObject(const QString& qsSrcObjectName, const QString& qsDestBucket, const QString& qsDestObjectName);

Remarks

This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.

If the VersionId property is non-empty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.

If there are any metadata items present in the Metadata properties, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.

Notes:

• Objects may only be copied to buckets that exist within the same region.
• Objects larger than 5GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload, and then use the CopyPart method to create parts for said multipart upload using the source object's data.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CopyPart Method (AmazonS3 Class)

Copies the specified object as a part of a multipart upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CopyPart(const char* lpszSrcObjectName, const char* lpszDestBucket, const char* lpszDestObjectName, int iDestPartNumber, const char* lpszDestUploadId);

Unicode (Windows)
INT CopyPart(LPCWSTR lpszSrcObjectName, LPCWSTR lpszDestBucket, LPCWSTR lpszDestObjectName, INT iDestPartNumber, LPCWSTR lpszDestUploadId);

int cloudstorage_amazons3_copypart(void* lpObj, const char* lpszSrcObjectName, const char* lpszDestBucket, const char* lpszDestObjectName, int iDestPartNumber, const char* lpszDestUploadId);

int CopyPart(const QString& qsSrcObjectName, const QString& qsDestBucket, const QString& qsDestObjectName, int iDestPartNumber, const QString& qsDestUploadId);

Remarks

This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.

The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.

To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateBucket Method (AmazonS3 Class)

Creates a new bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateBucket();

Unicode (Windows)
INT CreateBucket();

int cloudstorage_amazons3_createbucket(void* lpObj);

int CreateBucket();

Remarks

This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

CreateObject Method (AmazonS3 Class)

Creates a new object in the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateObject(const char* lpszObjectName);

Unicode (Windows)
INT CreateObject(LPCWSTR lpszObjectName);

int cloudstorage_amazons3_createobject(void* lpObj, const char* lpszObjectName);

int CreateObject(const QString& qsObjectName);

Remarks

This method creates a new object named Object in the bucket currently selected by Bucket. If there are any metadata items present in the Metadata properties, they will included in the creation request.

If SetUploadStream has been used to set an upload stream, it will take priority as the data source. If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

This method can automatically handle the multipart upload of objects (See Below). If it is desired to manually take control of the multipart upload process see StartMultipartUpload.

Automatic Multipart Uploads

If more than SimpleUploadLimit bytes of data are provided, the class will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the class automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.

If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.

When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteBucket Method (AmazonS3 Class)

Deletes a bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteBucket();

Unicode (Windows)
INT DeleteBucket();

int cloudstorage_amazons3_deletebucket(void* lpObj);

int DeleteBucket();

Remarks

This method deletes the bucket currently selected by Bucket. Note that bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DeleteObject Method (AmazonS3 Class)

Deletes an object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteObject(const char* lpszObjectName);

Unicode (Windows)
INT DeleteObject(LPCWSTR lpszObjectName);

int cloudstorage_amazons3_deleteobject(void* lpObj, const char* lpszObjectName);

int DeleteObject(const QString& qsObjectName);

Remarks

This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.

If the VersionId property is non-empty, this method deletes the specified version of the object instead.

Deleting Versioned Objects

If an object's latest version is a delete marker, then the server treats the object as if it didn't exist (i.e., it doesn't appear when listing objects, cannot be downloaded, etc.). However, all of the previous versions of the object (including one that existed just before the delete marker was created) still exist; they can be listed using ListVersions, and explicitly interacted with by setting VersionId and calling an appropriate method.

To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.

Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DisableVersioning Method (AmazonS3 Class)

Disables versioning for the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DisableVersioning();

Unicode (Windows)
INT DisableVersioning();

int cloudstorage_amazons3_disableversioning(void* lpObj);

int DisableVersioning();

Remarks

This method can be used to disable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

DoEvents Method (AmazonS3 Class)

This method processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int cloudstorage_amazons3_doevents(void* lpObj);

int DoEvents();

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

EnableVersioning Method (AmazonS3 Class)

Enables versioning for the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EnableVersioning();

Unicode (Windows)
INT EnableVersioning();

int cloudstorage_amazons3_enableversioning(void* lpObj);

int EnableVersioning();

Remarks

This method can be used to enable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetBucketLocation Method (AmazonS3 Class)

Gets a bucket's location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBucketLocation();

Unicode (Windows)
LPWSTR GetBucketLocation();

char* cloudstorage_amazons3_getbucketlocation(void* lpObj);

QString GetBucketLocation();

Remarks

This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetLink Method (AmazonS3 Class)

Creates a link that provides access to an object for a specified amount of time.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLink(const char* lpszObjectName, int iExpires);

Unicode (Windows)
LPWSTR GetLink(LPCWSTR lpszObjectName, INT iExpires);

char* cloudstorage_amazons3_getlink(void* lpObj, const char* lpszObjectName, int iExpires);

QString GetLink(const QString& qsObjectName, int iExpires);

Remarks

This method creates and returns a pre-authenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, a link is created for the specified version of the object.

The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.

Note that this method is an offline method that simply generates a pre-signed URL; no communication with the server takes place.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetObject Method (AmazonS3 Class)

Downloads an object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObject(const char* lpszObjectName);

Unicode (Windows)
INT GetObject(LPCWSTR lpszObjectName);

int cloudstorage_amazons3_getobject(void* lpObj, const char* lpszObjectName);

int GetObject(const QString& qsObjectName);

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.

If a stream has been specified using SetDownloadStream, the object data will be sent through it. If a stream is not specified, and LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.

To download and decrypt an encrypted object, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading an object looks like this: s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name);

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name);

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetObjectInfo Method (AmazonS3 Class)

Gets an object's information and metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjectInfo(const char* lpszObjectName);

Unicode (Windows)
INT GetObjectInfo(LPCWSTR lpszObjectName);

int cloudstorage_amazons3_getobjectinfo(void* lpObj, const char* lpszObjectName);

int GetObjectInfo(const QString& qsObjectName);

Remarks

This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is non-empty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the ObjectList and MetadataList events, and will re-populate the Objects and Metadata collection properties.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetTorrent Method (AmazonS3 Class)

Gets a torrent file that can be used to download an object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTorrent(const char* lpszObjectName);

Unicode (Windows)
INT GetTorrent(LPCWSTR lpszObjectName);

int cloudstorage_amazons3_gettorrent(void* lpObj, const char* lpszObjectName);

int GetTorrent(const QString& qsObjectName);

Remarks

This method gets a torrent file for the object specified by ObjectName in the bucket currently selected by Bucket.

If a stream has been specified using SetDownloadStream, the torrent file will be sent through it. If a stream is not specified, and LocalFile is set, the torrent file will be saved to the specified location; otherwise, the torrent file will be held by ObjectData.

Note that, according to Amazon's documentation:

• Torrent files are only available for publicly-accessible objects less than 5GB in size.
• Torrent files cannot be requested for objects located in AWS regions that launched after May 30, 2016.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Interrupt Method (AmazonS3 Class)

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudstorage_amazons3_interrupt(void* lpObj);

int Interrupt();

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListBuckets Method (AmazonS3 Class)

Lists all buckets in the account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListBuckets();

Unicode (Windows)
INT ListBuckets();

int cloudstorage_amazons3_listbuckets(void* lpObj);

int ListBuckets();

Remarks

This method lists all buckets in the account.

Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets properties.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListMultipartUploads Method (AmazonS3 Class)

Lists the current multipart uploads.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMultipartUploads();

Unicode (Windows)
INT ListMultipartUploads();

int cloudstorage_amazons3_listmultipartuploads(void* lpObj);

int ListMultipartUploads();

Remarks

This method lists the current multipart uploads in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each multipart upload, and will also populate the Objects properties.

If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Objects properties every time a page of results is returned.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListObjects Method (AmazonS3 Class)

Lists the objects in a bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListObjects();

Unicode (Windows)
INT ListObjects();

int cloudstorage_amazons3_listobjects(void* lpObj);

int ListObjects();

Remarks

This method lists the objects in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object, and will also populate the Objects properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more objects available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Objects properties every time a page of results is returned.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListParts Method (AmazonS3 Class)

Lists the parts in a multipart upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListParts(const char* lpszObjectName, const char* lpszUploadId);

Unicode (Windows)
INT ListParts(LPCWSTR lpszObjectName, LPCWSTR lpszUploadId);

int cloudstorage_amazons3_listparts(void* lpObj, const char* lpszObjectName, const char* lpszUploadId);

int ListParts(const QString& qsObjectName, const QString& qsUploadId);

Remarks

This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.

Calling this method will fire the PartList event once for each part, and will also populate the Parts properties.

If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Parts properties every time a page of results is returned.

Note that this method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the class will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListVersions Method (AmazonS3 Class)

Lists the object versions in a bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListVersions();

Unicode (Windows)
INT ListVersions();

int cloudstorage_amazons3_listversions(void* lpObj);

int ListVersions();

Remarks

This method lists the object versions in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object version, and will also populate the Objects properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more object versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the Objects properties every time a page of results is returned.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (AmazonS3 Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudstorage_amazons3_reset(void* lpObj);

int Reset();

Remarks

This method resets the class to its initial state.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResetHeaders Method (AmazonS3 Class)

Resets all HTTP headers, cookies, and LocalFile.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetHeaders();

Unicode (Windows)
INT ResetHeaders();

int cloudstorage_amazons3_resetheaders(void* lpObj);

int ResetHeaders();

Remarks

Resets all the HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata and QueryParams collection properties.

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SendCustomRequest Method (AmazonS3 Class)

Sends a custom request to the server.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SendCustomRequest(const char* lpszHttpMethod, const char* lpszObjectName, const char* lpszRequestBody);

Unicode (Windows)
INT SendCustomRequest(LPCWSTR lpszHttpMethod, LPCWSTR lpszObjectName, LPCWSTR lpszRequestBody);

int cloudstorage_amazons3_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszObjectName, const char* lpszRequestBody);

int SendCustomRequest(const QString& qsHttpMethod, const QString& qsObjectName, const QString& qsRequestBody);

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The ObjectName and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, based on the following:
   • UseSSL, Region, and UseVirtualHosting for the base URL.
     • Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
   • Bucket (if non-empty)
   • ObjectName (if non-empty)
   • VersionId (if both it and ObjectName are non-empty)
   • QueryParams
2. Adds request headers from:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • ProductToken
   • SessionToken
   • UserToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeaders properties; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or ObjectData (using the same logic as GetObject).

If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetDownloadStream Method (AmazonS3 Class)

Sets the stream to which downloaded data will be written.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetDownloadStream(CloudStorageStream* sDownloadStream);

Unicode (Windows)
INT SetDownloadStream(CloudStorageStream* sDownloadStream);

int cloudstorage_amazons3_setdownloadstream(void* lpObj, CloudStorageStream* sDownloadStream);

int SetDownloadStream(CloudStorageStream* sDownloadStream);

Remarks

If a download stream is set before data is downloaded, the downloaded data will be written to the stream. The stream should be open and normally set to position 0.

Note: Passing a non-null value for DownloadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetUploadStream Method (AmazonS3 Class)

Sets the stream from which data is read when uploading.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetUploadStream(CloudStorageStream* sUploadStream);

Unicode (Windows)
INT SetUploadStream(CloudStorageStream* sUploadStream);

int cloudstorage_amazons3_setuploadstream(void* lpObj, CloudStorageStream* sUploadStream);

int SetUploadStream(CloudStorageStream* sUploadStream);

Remarks

If an upload stream is set before data is uploaded, the content of the stream will be read by the class and uploaded to the server. The stream should be open and normally set to position 0.

Note: Passing a non-null value for UploadStream will cause LocalFile to be cleared. Similarly, setting LocalFile to a non-empty value will discard any stream set using this method.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

StartMultipartUpload Method (AmazonS3 Class)

Starts a new manual multipart upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* StartMultipartUpload(const char* lpszObjectName);

Unicode (Windows)
LPWSTR StartMultipartUpload(LPCWSTR lpszObjectName);

char* cloudstorage_amazons3_startmultipartupload(void* lpObj, const char* lpszObjectName);

QString StartMultipartUpload(const QString& qsObjectName);

Remarks

This method starts a new "manual" multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. For an "automatic" multipart upload see the CreateObject method. This upload Id can then be used to call the following methods:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

If there are any metadata items present in the Metadata properties, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

UpdateBucketACL Method (AmazonS3 Class)

Updates a bucket's canned access policy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateBucketACL();

Unicode (Windows)
INT UpdateBucketACL();

int cloudstorage_amazons3_updatebucketacl(void* lpObj);

int UpdateBucketACL();

Remarks

This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UpdateObjectACL Method (AmazonS3 Class)

Updates an object's canned access policy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateObjectACL(const char* lpszObjectName);

Unicode (Windows)
INT UpdateObjectACL(LPCWSTR lpszObjectName);

int cloudstorage_amazons3_updateobjectacl(void* lpObj, const char* lpszObjectName);

int UpdateObjectACL(const QString& qsObjectName);

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.

If the VersionId property is non-empty, the canned access policy of the specified version of the object is updated instead.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

UploadPart Method (AmazonS3 Class)

Uploads a multipart upload part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UploadPart(const char* lpszObjectName, int iPartNumber, const char* lpszUploadId);

Unicode (Windows)
INT UploadPart(LPCWSTR lpszObjectName, INT iPartNumber, LPCWSTR lpszUploadId);

int cloudstorage_amazons3_uploadpart(void* lpObj, const char* lpszObjectName, int iPartNumber, const char* lpszUploadId);

int UploadPart(const QString& qsObjectName, int iPartNumber, const QString& qsUploadId);

Remarks

This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.

PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly-uploaded part.

The data to upload is taken from either the stream set using SetUploadStream, LocalFile, or ObjectData (whichever data is found in first, when checked in that order). Each part must be at least 5MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.

If the IncludePartMD5 configuration setting is true, the class will include an MD5 digest of its data when sending it to the server. The server will then verify that the data was received without corruption.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

BucketList Event (AmazonS3 Class)

Fires once for each bucket returned when listing buckets.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBucketList(AmazonS3BucketListEventParams *e);

typedef struct {
  const char *BucketName;
  const char *CreationDate;
  const char *OwnerId;
  const char *OwnerName;
  int reserved;
} AmazonS3BucketListEventParams;


Unicode (Windows)
virtual INT FireBucketList(AmazonS3BucketListEventParams *e);

typedef struct {
  LPCWSTR BucketName;
  LPCWSTR CreationDate;
  LPCWSTR OwnerId;
  LPCWSTR OwnerName;
  INT reserved;
} AmazonS3BucketListEventParams;

#define EID_AMAZONS3_BUCKETLIST 1

virtual INT CLOUDSTORAGE_CALL FireBucketList(LPSTR &lpszBucketName, LPSTR &lpszCreationDate, LPSTR &lpszOwnerId, LPSTR &lpszOwnerName);

class AmazonS3BucketListEventParams {
public:
  const QString &BucketName();

  const QString &CreationDate();

  const QString &OwnerId();

  const QString &OwnerName();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BucketList(AmazonS3BucketListEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireBucketList(AmazonS3BucketListEventParams *e) {...}

Remarks

This event fires once for each bucket returned when ListBuckets is called.

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.

EndTransfer Event (AmazonS3 Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndTransfer(AmazonS3EndTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AmazonS3EndTransferEventParams;


Unicode (Windows)
virtual INT FireEndTransfer(AmazonS3EndTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AmazonS3EndTransferEventParams;

#define EID_AMAZONS3_ENDTRANSFER 2

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class AmazonS3EndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndTransfer(AmazonS3EndTransferEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireEndTransfer(AmazonS3EndTransferEventParams *e) {...}

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (AmazonS3 Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AmazonS3ErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AmazonS3ErrorEventParams;


Unicode (Windows)
virtual INT FireError(AmazonS3ErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AmazonS3ErrorEventParams;

#define EID_AMAZONS3_ERROR 3

virtual INT CLOUDSTORAGE_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AmazonS3ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AmazonS3ErrorEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireError(AmazonS3ErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (AmazonS3 Class)

Fires after each part in an automatic multipart upload is complete.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireFragmentComplete(AmazonS3FragmentCompleteEventParams *e);

typedef struct {
  int FragmentNumber;
  int FragmentCount;
  int Interrupt;
  int reserved;
} AmazonS3FragmentCompleteEventParams;


Unicode (Windows)
virtual INT FireFragmentComplete(AmazonS3FragmentCompleteEventParams *e);

typedef struct {
  INT FragmentNumber;
  INT FragmentCount;
  BOOL Interrupt;
  INT reserved;
} AmazonS3FragmentCompleteEventParams;

#define EID_AMAZONS3_FRAGMENTCOMPLETE 4

virtual INT CLOUDSTORAGE_CALL FireFragmentComplete(INT &iFragmentNumber, INT &iFragmentCount, BOOL &bInterrupt);

class AmazonS3FragmentCompleteEventParams {
public:
  int FragmentNumber();

  int FragmentCount();

  bool Interrupt();
  void SetInterrupt(bool bInterrupt);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void FragmentComplete(AmazonS3FragmentCompleteEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireFragmentComplete(AmazonS3FragmentCompleteEventParams *e) {...}

Remarks

If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part that has completed. This value starts at 1.

FragmentCount is the total number of parts that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Refer to CreateObject for more information.

Header Event (AmazonS3 Class)

Fired every time a header line comes in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireHeader(AmazonS3HeaderEventParams *e);

typedef struct {
  const char *Field;
  const char *Value;
  int reserved;
} AmazonS3HeaderEventParams;


Unicode (Windows)
virtual INT FireHeader(AmazonS3HeaderEventParams *e);

typedef struct {
  LPCWSTR Field;
  LPCWSTR Value;
  INT reserved;
} AmazonS3HeaderEventParams;

#define EID_AMAZONS3_HEADER 5

virtual INT CLOUDSTORAGE_CALL FireHeader(LPSTR &lpszField, LPSTR &lpszValue);

class AmazonS3HeaderEventParams {
public:
  const QString &Field();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Header(AmazonS3HeaderEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireHeader(AmazonS3HeaderEventParams *e) {...}

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (AmazonS3 Class)

Fired once for each log message.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireLog(AmazonS3LogEventParams *e);

typedef struct {
  int LogLevel;
  const char *Message;
  const char *LogType;
  int reserved;
} AmazonS3LogEventParams;


Unicode (Windows)
virtual INT FireLog(AmazonS3LogEventParams *e);

typedef struct {
  INT LogLevel;
  LPCWSTR Message;
  LPCWSTR LogType;
  INT reserved;
} AmazonS3LogEventParams;

#define EID_AMAZONS3_LOG 6

virtual INT CLOUDSTORAGE_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);

class AmazonS3LogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Log(AmazonS3LogEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireLog(AmazonS3LogEventParams *e) {...}

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MetadataList Event (AmazonS3 Class)

Fires once for each metadata item returned when object information and metadata is retrieved.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMetadataList(AmazonS3MetadataListEventParams *e);

typedef struct {
  const char *Name;
  const char *Value;
  int reserved;
} AmazonS3MetadataListEventParams;


Unicode (Windows)
virtual INT FireMetadataList(AmazonS3MetadataListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Value;
  INT reserved;
} AmazonS3MetadataListEventParams;

#define EID_AMAZONS3_METADATALIST 7

virtual INT CLOUDSTORAGE_CALL FireMetadataList(LPSTR &lpszName, LPSTR &lpszValue);

class AmazonS3MetadataListEventParams {
public:
  const QString &Name();

  const QString &Value();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void MetadataList(AmazonS3MetadataListEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireMetadataList(AmazonS3MetadataListEventParams *e) {...}

Remarks

This event fires once for each metadata item returned when GetObjectInfo is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.

Value is the metadata item's value.

ObjectList Event (AmazonS3 Class)

Fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireObjectList(AmazonS3ObjectListEventParams *e);

typedef struct {
  const char *BucketName;
  const char *ObjectName;
  const char *LastModified;
  int64 Size;
  const char *ETag;
  const char *OwnerId;
  const char *OwnerName;
  const char *UploadId;
  const char *VersionId;
  int LatestVersion;
  int Deleted;
  int reserved;
} AmazonS3ObjectListEventParams;


Unicode (Windows)
virtual INT FireObjectList(AmazonS3ObjectListEventParams *e);

typedef struct {
  LPCWSTR BucketName;
  LPCWSTR ObjectName;
  LPCWSTR LastModified;
  LONG64 Size;
  LPCWSTR ETag;
  LPCWSTR OwnerId;
  LPCWSTR OwnerName;
  LPCWSTR UploadId;
  LPCWSTR VersionId;
  BOOL LatestVersion;
  BOOL Deleted;
  INT reserved;
} AmazonS3ObjectListEventParams;

#define EID_AMAZONS3_OBJECTLIST 8

virtual INT CLOUDSTORAGE_CALL FireObjectList(LPSTR &lpszBucketName, LPSTR &lpszObjectName, LPSTR &lpszLastModified, LONG64 &lSize, LPSTR &lpszETag, LPSTR &lpszOwnerId, LPSTR &lpszOwnerName, LPSTR &lpszUploadId, LPSTR &lpszVersionId, BOOL &bLatestVersion, BOOL &bDeleted);

class AmazonS3ObjectListEventParams {
public:
  const QString &BucketName();

  const QString &ObjectName();

  const QString &LastModified();

  qint64 Size();

  const QString &ETag();

  const QString &OwnerId();

  const QString &OwnerName();

  const QString &UploadId();

  const QString &VersionId();

  bool LatestVersion();

  bool Deleted();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void ObjectList(AmazonS3ObjectListEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireObjectList(AmazonS3ObjectListEventParams *e) {...}

Remarks

This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object. Not applicable when ListMultipartUploads is called.

Size reflects the size, in bytes, of the object. Not applicable when ListMultipartUploads is called.

ETag reflects the object's ETag. Not applicable when ListMultipartUploads is called.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when GetObjectInfo is called.

UploadId reflects the Id of the multipart upload. Only applicable when ListMultipartUploads is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; empty in all other cases.

LatestVersion indicates whether this is the latest object version. Only applicable when ListVersions is called; true in all other cases.

Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; false in all other cases.

PartList Event (AmazonS3 Class)

Fires once for every part returned when listing a multipart upload's parts.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePartList(AmazonS3PartListEventParams *e);

typedef struct {
  int PartNumber;
  const char *ObjectName;
  const char *LastModified;
  int64 Size;
  const char *ETag;
  const char *OwnerId;
  const char *OwnerName;
  int reserved;
} AmazonS3PartListEventParams;


Unicode (Windows)
virtual INT FirePartList(AmazonS3PartListEventParams *e);

typedef struct {
  INT PartNumber;
  LPCWSTR ObjectName;
  LPCWSTR LastModified;
  LONG64 Size;
  LPCWSTR ETag;
  LPCWSTR OwnerId;
  LPCWSTR OwnerName;
  INT reserved;
} AmazonS3PartListEventParams;

#define EID_AMAZONS3_PARTLIST 9

virtual INT CLOUDSTORAGE_CALL FirePartList(INT &iPartNumber, LPSTR &lpszObjectName, LPSTR &lpszLastModified, LONG64 &lSize, LPSTR &lpszETag, LPSTR &lpszOwnerId, LPSTR &lpszOwnerName);

class AmazonS3PartListEventParams {
public:
  int PartNumber();

  const QString &ObjectName();

  const QString &LastModified();

  qint64 Size();

  const QString &ETag();

  const QString &OwnerId();

  const QString &OwnerName();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PartList(AmazonS3PartListEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FirePartList(AmazonS3PartListEventParams *e) {...}

Remarks

This event fires once for each multipart upload part returned when ListParts is called.

PartNumber reflects the part's number.

ObjectName reflects the name of the object the multipart upload is for.

LastModified reflects the last modified time of the part.

Size reflects the size, in bytes, of the part.

ETag reflects the part's ETag of the part.

OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.

PrefixList Event (AmazonS3 Class)

Fires once for each common prefix returned when listing objects.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePrefixList(AmazonS3PrefixListEventParams *e);

typedef struct {
  const char *BucketName;
  const char *Prefix;
  int reserved;
} AmazonS3PrefixListEventParams;


Unicode (Windows)
virtual INT FirePrefixList(AmazonS3PrefixListEventParams *e);

typedef struct {
  LPCWSTR BucketName;
  LPCWSTR Prefix;
  INT reserved;
} AmazonS3PrefixListEventParams;

#define EID_AMAZONS3_PREFIXLIST 10

virtual INT CLOUDSTORAGE_CALL FirePrefixList(LPSTR &lpszBucketName, LPSTR &lpszPrefix);

class AmazonS3PrefixListEventParams {
public:
  const QString &BucketName();

  const QString &Prefix();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PrefixList(AmazonS3PrefixListEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FirePrefixList(AmazonS3PrefixListEventParams *e) {...}

Remarks

This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

Progress Event (AmazonS3 Class)

Fires during an upload or download to indicate transfer progress.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(AmazonS3ProgressEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int64 TotalBytes;
  int PercentDone;
  int reserved;
} AmazonS3ProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(AmazonS3ProgressEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  LONG64 TotalBytes;
  INT PercentDone;
  INT reserved;
} AmazonS3ProgressEventParams;

#define EID_AMAZONS3_PROGRESS 11

virtual INT CLOUDSTORAGE_CALL FireProgress(INT &iDirection, LONG64 &lBytesTransferred, LONG64 &lTotalBytes, INT &iPercentDone);

class AmazonS3ProgressEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  qint64 TotalBytes();

  int PercentDone();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(AmazonS3ProgressEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireProgress(AmazonS3ProgressEventParams *e) {...}

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (AmazonS3 Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(AmazonS3SSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} AmazonS3SSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(AmazonS3SSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} AmazonS3SSLServerAuthenticationEventParams;

#define EID_AMAZONS3_SSLSERVERAUTHENTICATION 12

virtual INT CLOUDSTORAGE_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class AmazonS3SSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(AmazonS3SSLServerAuthenticationEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireSSLServerAuthentication(AmazonS3SSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (AmazonS3 Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(AmazonS3SSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} AmazonS3SSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(AmazonS3SSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} AmazonS3SSLStatusEventParams;

#define EID_AMAZONS3_SSLSTATUS 13

virtual INT CLOUDSTORAGE_CALL FireSSLStatus(LPSTR &lpszMessage);

class AmazonS3SSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(AmazonS3SSLStatusEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireSSLStatus(AmazonS3SSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (AmazonS3 Class)

This event fires when a document starts transferring (after the headers).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartTransfer(AmazonS3StartTransferEventParams *e);

typedef struct {
  int Direction;
  int reserved;
} AmazonS3StartTransferEventParams;


Unicode (Windows)
virtual INT FireStartTransfer(AmazonS3StartTransferEventParams *e);

typedef struct {
  INT Direction;
  INT reserved;
} AmazonS3StartTransferEventParams;

#define EID_AMAZONS3_STARTTRANSFER 14

virtual INT CLOUDSTORAGE_CALL FireStartTransfer(INT &iDirection);

class AmazonS3StartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartTransfer(AmazonS3StartTransferEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireStartTransfer(AmazonS3StartTransferEventParams *e) {...}

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (AmazonS3 Class)

Fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireTransfer(AmazonS3TransferEventParams *e);

typedef struct {
  int Direction;
  int64 BytesTransferred;
  int PercentDone;
  const char *Text;
  int lenText;
  int reserved;
} AmazonS3TransferEventParams;


Unicode (Windows)
virtual INT FireTransfer(AmazonS3TransferEventParams *e);

typedef struct {
  INT Direction;
  LONG64 BytesTransferred;
  INT PercentDone;
  LPCSTR Text;
  INT lenText;
  INT reserved;
} AmazonS3TransferEventParams;

#define EID_AMAZONS3_TRANSFER 15

virtual INT CLOUDSTORAGE_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);

class AmazonS3TransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Transfer(AmazonS3TransferEventParams *e);

// Or, subclass AmazonS3 and override this emitter function.
virtual int FireTransfer(AmazonS3TransferEventParams *e) {...}

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Certificate Type

This is the digital certificate being used.

Syntax

CloudStorageCertificate (declared in cloudstorage.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields