AmazonGlacier Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonGlacier class provides a quick way to interface with Amazon's Glacier service.

Syntax

AmazonGlacier

Remarks

The AmazonGlacier class allows you to simply access Amazon's Glacier service. Glacier allows you to create vaults and store archives.

Before using the class you must first have an AWS account and sign up for the Glacier service. To use the class first set AccessKey and SecretKey.

To create a vault call CreateVault. Once the vault is created you are ready to upload archives to store in the vault. Set LocalFile to the file you want to upload and call UploadArchive.

To retrieve an archive you must create a job. Jobs are long running operations and Amazon will notify you when the job is complete. To create a job call CreateJob. Use the SetNotificationInfo method to set notification options at the vault level. You may also supply an Amazon SNS topic to CreateJob to which Amazon will publish notification about the job status.

You can also call CreateJob to create an Inventory Retrieval job to list the contents of a vault.

After the job is complete use GetJobOutput to retrieve the data.

Additionally, multipart uploads are supported through the StartMultipartUpload and CompleteMultipartUpload methods. Various other operations such as DeleteArchive, GetJobInfo, ListJobs, ListMultipartUploads, ListVaults, and more provide additional functionality.

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 (AmazonGlacier 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_amazonglacier_getaccesskey(void* lpObj);
int cloudstorage_amazonglacier_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

ArchiveData Property (AmazonGlacier Class)

Holds the archive data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetArchiveData(char* &lpArchiveData, int &lenArchiveData);
int SetArchiveData(const char* lpArchiveData, int lenArchiveData);

Unicode (Windows)
INT GetArchiveData(LPSTR &lpArchiveData, INT &lenArchiveData);
INT SetArchiveData(LPCSTR lpArchiveData, INT lenArchiveData);

int cloudstorage_amazonglacier_getarchivedata(void* lpObj, char** lpArchiveData, int* lenArchiveData);
int cloudstorage_amazonglacier_setarchivedata(void* lpObj, const char* lpArchiveData, int lenArchiveData);

QByteArray GetArchiveData();
int SetArchiveData(QByteArray qbaArchiveData);

Default Value

""

Remarks

This property holds the archive data. It is populated after calling GetJobOutput when the job is an archive retrieval. It may be set to archive data before calling UploadArchive.

This property is not available at design time.

Data Type

Binary String

EncryptionAlgorithm Property (AmazonGlacier 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_amazonglacier_getencryptionalgorithm(void* lpObj);
int cloudstorage_amazonglacier_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 (AmazonGlacier 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_amazonglacier_getencryptionpassword(void* lpObj);
int cloudstorage_amazonglacier_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

FirewallAutoDetect Property (AmazonGlacier Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int cloudstorage_amazonglacier_getfirewallautodetect(void* lpObj);
int cloudstorage_amazonglacier_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AmazonGlacier Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int cloudstorage_amazonglacier_getfirewalltype(void* lpObj);
int cloudstorage_amazonglacier_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AmazonGlacier Class)

This property contains the name or IP address of firewall (optional).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* cloudstorage_amazonglacier_getfirewallhost(void* lpObj);
int cloudstorage_amazonglacier_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (AmazonGlacier Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* cloudstorage_amazonglacier_getfirewallpassword(void* lpObj);
int cloudstorage_amazonglacier_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (AmazonGlacier Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int cloudstorage_amazonglacier_getfirewallport(void* lpObj);
int cloudstorage_amazonglacier_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AmazonGlacier Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* cloudstorage_amazonglacier_getfirewalluser(void* lpObj);
int cloudstorage_amazonglacier_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

Idle Property (AmazonGlacier Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_amazonglacier_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

InventoryData Property (AmazonGlacier Class)

Holds the inventory data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetInventoryData(char* &lpInventoryData, int &lenInventoryData);

Unicode (Windows)
INT GetInventoryData(LPSTR &lpInventoryData, INT &lenInventoryData);

int cloudstorage_amazonglacier_getinventorydata(void* lpObj, char** lpInventoryData, int* lenInventoryData);

QByteArray GetInventoryData();

Default Value

""

Remarks

This property holds the inventory data and is populated after calling GetJobOutput if the job is an inventory retrieval job.

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

Data Type

Binary String

JobMarker Property (AmazonGlacier Class)

A marker used to get the next page of results.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobMarker();
int SetJobMarker(const char* lpszJobMarker);

Unicode (Windows)
LPWSTR GetJobMarker();
INT SetJobMarker(LPCWSTR lpszJobMarker);

char* cloudstorage_amazonglacier_getjobmarker(void* lpObj);
int cloudstorage_amazonglacier_setjobmarker(void* lpObj, const char* lpszJobMarker);

QString GetJobMarker();
int SetJobMarker(QString qsJobMarker);

Default Value

""

Remarks

This property is populated after calling ListJobs if the results are paged. This property holds the marker that will be sent in the next call to ListJobs to get the next page of results.

This property is not available at design time.

Data Type

String

JobCount Property (AmazonGlacier Class)

The number of records in the Job arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetJobCount();

Unicode (Windows)
INT GetJobCount();

int cloudstorage_amazonglacier_getjobcount(void* lpObj);

int GetJobCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• JobArchiveId
• JobArchiveSHA256TreeHash
• JobArchiveSize
• JobCompleted
• JobCompletionDate
• JobCreationDate
• JobDescription
• JobId
• JobInventorySize
• JobSHA256TreeHash
• JobSNSTopic
• JobStatusCode
• JobStatusMessage
• JobType
• JobVaultArn

The array indices start at 0 and end at JobCount - 1.

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

Data Type

Integer

JobArchiveId Property (AmazonGlacier Class)

This property is populated with the ArchiveId associated with the Job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobArchiveId(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobArchiveId(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobarchiveid(void* lpObj, int jobindex);

QString GetJobArchiveId(int iJobIndex);

Default Value

""

Remarks

This property is populated with the ArchiveId associated with the Job.

This is only applicable when JobType is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobArchiveSHA256TreeHash Property (AmazonGlacier Class)

The SHA256 tree hash of the entire archive for an archive retrieval job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobArchiveSHA256TreeHash(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobArchiveSHA256TreeHash(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobarchivesha256treehash(void* lpObj, int jobindex);

QString GetJobArchiveSHA256TreeHash(int iJobIndex);

Default Value

""

Remarks

The SHA256 tree hash of the entire archive for an archive retrieval job.

This is only applicable when JobType is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobArchiveSize Property (AmazonGlacier Class)

The size of the archive in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetJobArchiveSize(int iJobIndex);

Unicode (Windows)
LONG64 GetJobArchiveSize(INT iJobIndex);

int64 cloudstorage_amazonglacier_getjobarchivesize(void* lpObj, int jobindex);

qint64 GetJobArchiveSize(int iJobIndex);

Default Value

0

Remarks

The size of the archive in bytes.

This is only applicable when JobType is 0 (archive retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

Long64

JobCompleted Property (AmazonGlacier Class)

Indicates the completion status of the job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetJobCompleted(int iJobIndex);

Unicode (Windows)
BOOL GetJobCompleted(INT iJobIndex);

int cloudstorage_amazonglacier_getjobcompleted(void* lpObj, int jobindex);

bool GetJobCompleted(int iJobIndex);

Default Value

FALSE

Remarks

Indicates the completion status of the job. By default both incomplete jobs and recently completed jobs are returned when calling ListJobs. See JobCompletionFilter for more options.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

Boolean

JobCompletionDate Property (AmazonGlacier Class)

The UTC time that the job completed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobCompletionDate(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobCompletionDate(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobcompletiondate(void* lpObj, int jobindex);

QString GetJobCompletionDate(int iJobIndex);

Default Value

""

Remarks

The UTC time that the job completed.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobCreationDate Property (AmazonGlacier Class)

The UTC time that the job was created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobCreationDate(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobCreationDate(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobcreationdate(void* lpObj, int jobindex);

QString GetJobCreationDate(int iJobIndex);

Default Value

""

Remarks

The UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobDescription Property (AmazonGlacier Class)

The user supplied description.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobDescription(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobDescription(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobdescription(void* lpObj, int jobindex);

QString GetJobDescription(int iJobIndex);

Default Value

""

Remarks

The user supplied description. This is specified by the JobDescription setting before calling CreateJob.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobInventorySize Property (AmazonGlacier Class)

The size in bytes of the inventory data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetJobInventorySize(int iJobIndex);

Unicode (Windows)
LONG64 GetJobInventorySize(INT iJobIndex);

int64 cloudstorage_amazonglacier_getjobinventorysize(void* lpObj, int jobindex);

qint64 GetJobInventorySize(int iJobIndex);

Default Value

0

Remarks

The size in bytes of the inventory data. This is only applicable when JobType is 1 (inventory retrieval).

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

Long64

JobId Property (AmazonGlacier Class)

The Amazon assigned JobId.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobId(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobId(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobid(void* lpObj, int jobindex);

QString GetJobId(int iJobIndex);

Default Value

""

Remarks

The Amazon assigned JobId.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobSHA256TreeHash Property (AmazonGlacier Class)

The SHA256 tree hash value for the requested range of an archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobSHA256TreeHash(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobSHA256TreeHash(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobsha256treehash(void* lpObj, int jobindex);

QString GetJobSHA256TreeHash(int iJobIndex);

Default Value

""

Remarks

The SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

When the whole archive is retrieved this values is the same as JobArchiveSHA256TreeHash.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobSNSTopic Property (AmazonGlacier Class)

The Amazon SNS topic that will receive notifications about the job status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobSNSTopic(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobSNSTopic(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobsnstopic(void* lpObj, int jobindex);

QString GetJobSNSTopic(int iJobIndex);

Default Value

""

Remarks

The Amazon SNS topic that will receive notifications about the job status.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobStatusCode Property (AmazonGlacier Class)

The current status of the job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetJobStatusCode(int iJobIndex);

Unicode (Windows)
INT GetJobStatusCode(INT iJobIndex);

JS_NONE(0), 
JS_IN_PROGRESS(1), 
JS_SUCCEEDED(2), 
JS_FAILED(3)

int cloudstorage_amazonglacier_getjobstatuscode(void* lpObj, int jobindex);

int GetJobStatusCode(int iJobIndex);

Default Value

0

Remarks

The current status of the job. Possible values are:

• jsNone (0)
• jsInProgress (1)
• jsSucceeded (2)
• jsFailed (3)

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

Integer

JobStatusMessage Property (AmazonGlacier Class)

A user friendly description of the status.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobStatusMessage(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobStatusMessage(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobstatusmessage(void* lpObj, int jobindex);

QString GetJobStatusMessage(int iJobIndex);

Default Value

""

Remarks

A user friendly description of the status.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

JobType Property (AmazonGlacier Class)

The type of the current job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetJobType(int iJobIndex);

Unicode (Windows)
INT GetJobType(INT iJobIndex);

JT_ARCHIVE_RETRIEVAL(0), 
JT_INVENTORY_RETRIEVAL(1)

int cloudstorage_amazonglacier_getjobtype(void* lpObj, int jobindex);

int GetJobType(int iJobIndex);

Default Value

0

Remarks

The type of the current job. Possible values are:

• jtArchiveRetrieval (0)
• jtInventoryRetrieval (1)

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

Integer

JobVaultArn Property (AmazonGlacier Class)

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetJobVaultArn(int iJobIndex);

Unicode (Windows)
LPWSTR GetJobVaultArn(INT iJobIndex);

char* cloudstorage_amazonglacier_getjobvaultarn(void* lpObj, int jobindex);

QString GetJobVaultArn(int iJobIndex);

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

The JobIndex parameter specifies the index of the item in the array. The size of the array is controlled by the JobCount property.

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

Data Type

String

LocalFile Property (AmazonGlacier Class)

The path to a local file for uploading or downloading.

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_amazonglacier_getlocalfile(void* lpObj);
wchar_t* cloudstorage_amazonglacier_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_amazonglacier_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_amazonglacier_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

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

Default Value

""

Remarks

This property is used to specify a local file that will be used for uploading or downloading. Set this to a local file before calling GetJobOutput. Set this to a local file to upload before calling UploadArchive.

This property is not available at design time.

Data Type

String

LocalHost Property (AmazonGlacier 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_amazonglacier_getlocalhost(void* lpObj);
int cloudstorage_amazonglacier_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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

MultipartUploadMarker Property (AmazonGlacier Class)

A marker used to get the next page of results.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMultipartUploadMarker();
int SetMultipartUploadMarker(const char* lpszMultipartUploadMarker);

Unicode (Windows)
LPWSTR GetMultipartUploadMarker();
INT SetMultipartUploadMarker(LPCWSTR lpszMultipartUploadMarker);

char* cloudstorage_amazonglacier_getmultipartuploadmarker(void* lpObj);
int cloudstorage_amazonglacier_setmultipartuploadmarker(void* lpObj, const char* lpszMultipartUploadMarker);

QString GetMultipartUploadMarker();
int SetMultipartUploadMarker(QString qsMultipartUploadMarker);

Default Value

""

Remarks

This property is populated after calling ListMultipartUploads if the results are paged. This property holds the marker that will be sent in the next call to ListMultipartUploads to get the next page of results.

This property is not available at design time.

Data Type

String

MultipartUploadCount Property (AmazonGlacier Class)

The number of records in the MultipartUpload arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMultipartUploadCount();

Unicode (Windows)
INT GetMultipartUploadCount();

int cloudstorage_amazonglacier_getmultipartuploadcount(void* lpObj);

int GetMultipartUploadCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• MultipartUploadArchiveDescription
• MultipartUploadCreationDate
• MultipartUploadId
• MultipartUploadPartSize
• MultipartUploadVaultArn

The array indices start at 0 and end at MultipartUploadCount - 1.

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

Data Type

Integer

MultipartUploadArchiveDescription Property (AmazonGlacier Class)

The description of the archive (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMultipartUploadArchiveDescription(int iMultipartUploadIndex);

Unicode (Windows)
LPWSTR GetMultipartUploadArchiveDescription(INT iMultipartUploadIndex);

char* cloudstorage_amazonglacier_getmultipartuploadarchivedescription(void* lpObj, int multipartuploadindex);

QString GetMultipartUploadArchiveDescription(int iMultipartUploadIndex);

Default Value

""

Remarks

The description of the archive (if any).

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

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

Data Type

String

MultipartUploadCreationDate Property (AmazonGlacier Class)

The UTC time that the multipart upload was started.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMultipartUploadCreationDate(int iMultipartUploadIndex);

Unicode (Windows)
LPWSTR GetMultipartUploadCreationDate(INT iMultipartUploadIndex);

char* cloudstorage_amazonglacier_getmultipartuploadcreationdate(void* lpObj, int multipartuploadindex);

QString GetMultipartUploadCreationDate(int iMultipartUploadIndex);

Default Value

""

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

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

Data Type

String

MultipartUploadPartSize Property (AmazonGlacier Class)

The part size in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMultipartUploadPartSize(int iMultipartUploadIndex);

Unicode (Windows)
INT GetMultipartUploadPartSize(INT iMultipartUploadIndex);

int cloudstorage_amazonglacier_getmultipartuploadpartsize(void* lpObj, int multipartuploadindex);

int GetMultipartUploadPartSize(int iMultipartUploadIndex);

Default Value

0

Remarks

The part size in bytes. This is specified by the PartSize setting and is used when StartMultipartUpload is called.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

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

Data Type

Integer

MultipartUploadId Property (AmazonGlacier Class)

The Id of the multipart upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMultipartUploadId(int iMultipartUploadIndex);

Unicode (Windows)
LPWSTR GetMultipartUploadId(INT iMultipartUploadIndex);

char* cloudstorage_amazonglacier_getmultipartuploadid(void* lpObj, int multipartuploadindex);

QString GetMultipartUploadId(int iMultipartUploadIndex);

Default Value

""

Remarks

The Id of the multipart upload.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

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

Data Type

String

MultipartUploadVaultArn Property (AmazonGlacier Class)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMultipartUploadVaultArn(int iMultipartUploadIndex);

Unicode (Windows)
LPWSTR GetMultipartUploadVaultArn(INT iMultipartUploadIndex);

char* cloudstorage_amazonglacier_getmultipartuploadvaultarn(void* lpObj, int multipartuploadindex);

QString GetMultipartUploadVaultArn(int iMultipartUploadIndex);

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The MultipartUploadIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MultipartUploadCount property.

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

Data Type

String

NotifyEventType Property (AmazonGlacier Class)

This property specifies the type of enabled notifications for the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyEventType();
int SetNotifyEventType(int iNotifyEventType);

Unicode (Windows)
INT GetNotifyEventType();
INT SetNotifyEventType(INT iNotifyEventType);

ET_BOTH(0), 
ET_ARCHIVE_RETRIEVAL_COMPLETED(1), 
ET_INVENTORY_RETRIEVAL_COMPLETED(2)

int cloudstorage_amazonglacier_getnotifyeventtype(void* lpObj);
int cloudstorage_amazonglacier_setnotifyeventtype(void* lpObj, int iNotifyEventType);

int GetNotifyEventType();
int SetNotifyEventType(int iNotifyEventType);

Default Value

0

Remarks

This property specifies the type of enabled notifications for the vault. Possible values are:

This property is not available at design time.

Data Type

Integer

NotifySNSTopic Property (AmazonGlacier Class)

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifySNSTopic();
int SetNotifySNSTopic(const char* lpszNotifySNSTopic);

Unicode (Windows)
LPWSTR GetNotifySNSTopic();
INT SetNotifySNSTopic(LPCWSTR lpszNotifySNSTopic);

char* cloudstorage_amazonglacier_getnotifysnstopic(void* lpObj);
int cloudstorage_amazonglacier_setnotifysnstopic(void* lpObj, const char* lpszNotifySNSTopic);

QString GetNotifySNSTopic();
int SetNotifySNSTopic(QString qsNotifySNSTopic);

Default Value

""

Remarks

This property specifies the Amazon SNS Topic ARN that is used to deliver notifications. The topic must already exist.

This property is not available at design time.

Data Type

String

OtherHeaders Property (AmazonGlacier Class)

This property includes 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_amazonglacier_getotherheaders(void* lpObj);
int cloudstorage_amazonglacier_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 (AmazonGlacier Class)

Whether or not the class should overwrite files during transfer.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_amazonglacier_getoverwrite(void* lpObj);
int cloudstorage_amazonglacier_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

This property is a indicates whether or not the class should overwrite downloaded data. If Overwrite is false, the class fails with an error whenever LocalFile exists and GetJobOutput is called.

Data Type

Boolean

ParsedHeaderCount Property (AmazonGlacier Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int cloudstorage_amazonglacier_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

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

Data Type

Integer

ParsedHeaderField Property (AmazonGlacier Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderField(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

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

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

ParsedHeaderValue Property (AmazonGlacier Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetParsedHeaderValue(int iParsedHeaderIndex);

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

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

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

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

Data Type

String

PartMarker Property (AmazonGlacier Class)

A marker used to get the next page of results.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_amazonglacier_getpartmarker(void* lpObj);
int cloudstorage_amazonglacier_setpartmarker(void* lpObj, const char* lpszPartMarker);

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

Default Value

""

Remarks

This property is populated after calling ListParts if the results are paged. This property holds the marker that will be sent in the next call to ListParts to get the next page of results.

This property is not available at design time.

Data Type

String

PartCount Property (AmazonGlacier Class)

The number of records in the Part arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPartCount();

Unicode (Windows)
INT GetPartCount();

int cloudstorage_amazonglacier_getpartcount(void* lpObj);

int GetPartCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartArchiveDescription
• PartCreationDate
• PartSHA256TreeHash
• PartSize
• PartStartPosition
• PartUploadId
• PartVaultArn

The array indices start at 0 and end at PartCount - 1.

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

Data Type

Integer

PartArchiveDescription Property (AmazonGlacier Class)

The description of the archive (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartArchiveDescription(int iPartIndex);

Unicode (Windows)
LPWSTR GetPartArchiveDescription(INT iPartIndex);

char* cloudstorage_amazonglacier_getpartarchivedescription(void* lpObj, int partindex);

QString GetPartArchiveDescription(int iPartIndex);

Default Value

""

Remarks

The description of the archive (if any).

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

String

PartCreationDate Property (AmazonGlacier Class)

The UTC time that the multipart upload was started.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartCreationDate(int iPartIndex);

Unicode (Windows)
LPWSTR GetPartCreationDate(INT iPartIndex);

char* cloudstorage_amazonglacier_getpartcreationdate(void* lpObj, int partindex);

QString GetPartCreationDate(int iPartIndex);

Default Value

""

Remarks

The UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

String

PartSHA256TreeHash Property (AmazonGlacier Class)

The SHA256 tree hash value that Amazon calculated for the part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartSHA256TreeHash(int iPartIndex);

Unicode (Windows)
LPWSTR GetPartSHA256TreeHash(INT iPartIndex);

char* cloudstorage_amazonglacier_getpartsha256treehash(void* lpObj, int partindex);

QString GetPartSHA256TreeHash(int iPartIndex);

Default Value

""

Remarks

The SHA256 tree hash value that Amazon calculated for the part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

String

PartSize Property (AmazonGlacier Class)

The part size in bytes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPartSize(int iPartIndex);

Unicode (Windows)
LONG64 GetPartSize(INT iPartIndex);

int64 cloudstorage_amazonglacier_getpartsize(void* lpObj, int partindex);

qint64 GetPartSize(int iPartIndex);

Default Value

0

Remarks

The part size in bytes.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

Long64

PartStartPosition Property (AmazonGlacier Class)

The byte offset in the archive of the current part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPartStartPosition(int iPartIndex);

Unicode (Windows)
LONG64 GetPartStartPosition(INT iPartIndex);

int64 cloudstorage_amazonglacier_getpartstartposition(void* lpObj, int partindex);

qint64 GetPartStartPosition(int iPartIndex);

Default Value

0

Remarks

The byte offset in the archive of the current part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

Long64

PartUploadId Property (AmazonGlacier Class)

The Id of the multipart upload associated with this part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartUploadId(int iPartIndex);

Unicode (Windows)
LPWSTR GetPartUploadId(INT iPartIndex);

char* cloudstorage_amazonglacier_getpartuploadid(void* lpObj, int partindex);

QString GetPartUploadId(int iPartIndex);

Default Value

""

Remarks

The Id of the multipart upload associated with this part.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

String

PartVaultArn Property (AmazonGlacier Class)

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartVaultArn(int iPartIndex);

Unicode (Windows)
LPWSTR GetPartVaultArn(INT iPartIndex);

char* cloudstorage_amazonglacier_getpartvaultarn(void* lpObj, int partindex);

QString GetPartVaultArn(int iPartIndex);

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the Vault in which the archive is created.

The PartIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartCount property.

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

Data Type

String

ProxyAuthScheme Property (AmazonGlacier Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int cloudstorage_amazonglacier_getproxyauthscheme(void* lpObj);
int cloudstorage_amazonglacier_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

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

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (AmazonGlacier Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int cloudstorage_amazonglacier_getproxyautodetect(void* lpObj);
int cloudstorage_amazonglacier_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

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

Default Value

FALSE

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (AmazonGlacier Class)

This property contains a password if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* cloudstorage_amazonglacier_getproxypassword(void* lpObj);
int cloudstorage_amazonglacier_setproxypassword(void* lpObj, const char* lpszProxyPassword);

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

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (AmazonGlacier Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int cloudstorage_amazonglacier_getproxyport(void* lpObj);
int cloudstorage_amazonglacier_setproxyport(void* lpObj, int iProxyPort);

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

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (AmazonGlacier Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* cloudstorage_amazonglacier_getproxyserver(void* lpObj);
int cloudstorage_amazonglacier_setproxyserver(void* lpObj, const char* lpszProxyServer);

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

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (AmazonGlacier Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int cloudstorage_amazonglacier_getproxyssl(void* lpObj);
int cloudstorage_amazonglacier_setproxyssl(void* lpObj, int iProxySSL);

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

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (AmazonGlacier Class)

This property contains a username if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* cloudstorage_amazonglacier_getproxyuser(void* lpObj);
int cloudstorage_amazonglacier_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Region Property (AmazonGlacier 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_amazonglacier_getregion(void* lpObj);
int cloudstorage_amazonglacier_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 (AmazonGlacier 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_amazonglacier_getsecretkey(void* lpObj);
int cloudstorage_amazonglacier_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

SSLAcceptServerCertEncoded Property (AmazonGlacier Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int cloudstorage_amazonglacier_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_amazonglacier_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AmazonGlacier Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int cloudstorage_amazonglacier_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_amazonglacier_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AmazonGlacier Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int cloudstorage_amazonglacier_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_amazonglacier_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (AmazonGlacier Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* cloudstorage_amazonglacier_getsslcertstorepassword(void* lpObj);
int cloudstorage_amazonglacier_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (AmazonGlacier Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int cloudstorage_amazonglacier_getsslcertstoretype(void* lpObj);
int cloudstorage_amazonglacier_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (AmazonGlacier Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* cloudstorage_amazonglacier_getsslcertsubject(void* lpObj);
int cloudstorage_amazonglacier_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (AmazonGlacier Class)

This specifies the 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_amazonglacier_getsslprovider(void* lpObj);
int cloudstorage_amazonglacier_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:

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

SSLServerCertEncoded Property (AmazonGlacier Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (AmazonGlacier Class)

A 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_amazonglacier_gettimeout(void* lpObj);
int cloudstorage_amazonglacier_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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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 (AmazonGlacier 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_amazonglacier_getusessl(void* lpObj);
int cloudstorage_amazonglacier_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

VaultMarker Property (AmazonGlacier Class)

A marker used to get the next page of results.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVaultMarker();
int SetVaultMarker(const char* lpszVaultMarker);

Unicode (Windows)
LPWSTR GetVaultMarker();
INT SetVaultMarker(LPCWSTR lpszVaultMarker);

char* cloudstorage_amazonglacier_getvaultmarker(void* lpObj);
int cloudstorage_amazonglacier_setvaultmarker(void* lpObj, const char* lpszVaultMarker);

QString GetVaultMarker();
int SetVaultMarker(QString qsVaultMarker);

Default Value

""

Remarks

This property is populated after calling ListVaults if the results are paged. This property holds the marker that will be sent in the next call to ListVaults to get the next page of results.

This property is not available at design time.

Data Type

String

VaultCount Property (AmazonGlacier Class)

The number of records in the Vault arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVaultCount();

Unicode (Windows)
INT GetVaultCount();

int cloudstorage_amazonglacier_getvaultcount(void* lpObj);

int GetVaultCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• VaultArchiveCount
• VaultArn
• VaultCreationDate
• VaultLastInventoryDate
• VaultName
• VaultSize

The array indices start at 0 and end at VaultCount - 1.

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

Data Type

Integer

VaultArchiveCount Property (AmazonGlacier Class)

The number of archives in the vault as of LastInventoryDate .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVaultArchiveCount(int iVaultIndex);

Unicode (Windows)
INT GetVaultArchiveCount(INT iVaultIndex);

int cloudstorage_amazonglacier_getvaultarchivecount(void* lpObj, int vaultindex);

int GetVaultArchiveCount(int iVaultIndex);

Default Value

0

Remarks

The number of archives in the vault as of VaultLastInventoryDate.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

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

Data Type

Integer

VaultArn Property (AmazonGlacier Class)

The Amazon Resource Name (ARN) of the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVaultArn(int iVaultIndex);

Unicode (Windows)
LPWSTR GetVaultArn(INT iVaultIndex);

char* cloudstorage_amazonglacier_getvaultarn(void* lpObj, int vaultindex);

QString GetVaultArn(int iVaultIndex);

Default Value

""

Remarks

The Amazon Resource Name (ARN) of the vault.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

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

Data Type

String

VaultCreationDate Property (AmazonGlacier Class)

The date the vault was created, in Coordinated Universal Time (UTC).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVaultCreationDate(int iVaultIndex);

Unicode (Windows)
LPWSTR GetVaultCreationDate(INT iVaultIndex);

char* cloudstorage_amazonglacier_getvaultcreationdate(void* lpObj, int vaultindex);

QString GetVaultCreationDate(int iVaultIndex);

Default Value

""

Remarks

The date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

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

Data Type

String

VaultLastInventoryDate Property (AmazonGlacier Class)

The date of the last vault inventory, in Coordinated Universal Time (UTC).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVaultLastInventoryDate(int iVaultIndex);

Unicode (Windows)
LPWSTR GetVaultLastInventoryDate(INT iVaultIndex);

char* cloudstorage_amazonglacier_getvaultlastinventorydate(void* lpObj, int vaultindex);

QString GetVaultLastInventoryDate(int iVaultIndex);

Default Value

""

Remarks

The date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

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

Data Type

String

VaultName Property (AmazonGlacier Class)

The name of the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetVaultName(int iVaultIndex);

Unicode (Windows)
LPWSTR GetVaultName(INT iVaultIndex);

char* cloudstorage_amazonglacier_getvaultname(void* lpObj, int vaultindex);

QString GetVaultName(int iVaultIndex);

Default Value

""

Remarks

The name of the vault.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

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

Data Type

String

VaultSize Property (AmazonGlacier Class)

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetVaultSize(int iVaultIndex);

Unicode (Windows)
LONG64 GetVaultSize(INT iVaultIndex);

int64 cloudstorage_amazonglacier_getvaultsize(void* lpObj, int vaultindex);

qint64 GetVaultSize(int iVaultIndex);

Default Value

0

Remarks

The size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

The VaultIndex parameter specifies the index of the item in the array. The size of the array is controlled by the VaultCount property.

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

Data Type

Long64

AbortMultipartUpload Method (AmazonGlacier Class)

Aborts a multipart upload.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_amazonglacier_abortmultipartupload(void* lpObj, const char* lpszVaultName, const char* lpszUploadId);

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

Remarks

This method aborts a multipart upload specified by UploadId. UploadId is returned from the StartMultipartUpload method.

VaultName specifies the vault in which the archive is created.

Only multipart uploads that are not yet completed can be aborted.

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.)

CompleteMultipartUpload Method (AmazonGlacier Class)

Completes a multipart upload.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR CompleteMultipartUpload(LPCWSTR lpszVaultName, LPCWSTR lpszUploadId);

char* cloudstorage_amazonglacier_completemultipartupload(void* lpObj, const char* lpszVaultName, const char* lpszUploadId);

QString CompleteMultipartUpload(const QString& qsVaultName, const QString& qsUploadId);

Remarks

This method completes the current multipart upload specified by UploadId.

VaultName specifies the vault in which the archive was created.

This method returns the ArchiveId which identifies the newly created archive. If you call this method twice for the same multipart upload within a short period of time, the same ArchiveId will be returned.

If parts of the archive were uploaded using separate instances of the class you must first list all parts of the archive by calling ListParts until PartMarker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

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.

Config Method (AmazonGlacier 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_amazonglacier_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.

CreateJob Method (AmazonGlacier Class)

Creates a new job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateJob(const char* lpszVaultName, int iJobType, const char* lpszArchiveId, const char* lpszSNSTopic);

Unicode (Windows)
LPWSTR CreateJob(LPCWSTR lpszVaultName, INT iJobType, LPCWSTR lpszArchiveId, LPCWSTR lpszSNSTopic);

char* cloudstorage_amazonglacier_createjob(void* lpObj, const char* lpszVaultName, int iJobType, const char* lpszArchiveId, const char* lpszSNSTopic);

QString CreateJob(const QString& qsVaultName, int iJobType, const QString& qsArchiveId, const QString& qsSNSTopic);

Remarks

This method creates a new job. There are two types of jobs, archive retrieval and inventory retrieval. After the job is created this method will return the JobId. Amazon will then execute the job (which may take hours) and then notify you when it is complete.

VaultName specifies the name of the vault.

JobType specifies the operation. Possible values are:

ArchiveId specifies the archive to retrieve when JobType is set to 0 (archive retrieval).

SNSTopic specifies the SNS topic to which the notification will be posted when the operation is complete.

The GetJobInfo method may be called with the returned JobId to check the status of the job. Once the job is completed use the GetJobOutput method to retrieve the data.

Note: JobDescription may optionally be set. JobRetrievalByteRange may be set when JobType is 0 (archive retrieval). JobInventoryFormat may be set when JobType is set to 1 (inventory retrieval).

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.

CreateVault Method (AmazonGlacier Class)

Creates a new vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateVault(const char* lpszVaultName);

Unicode (Windows)
INT CreateVault(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_createvault(void* lpObj, const char* lpszVaultName);

int CreateVault(const QString& qsVaultName);

Remarks

This method creates a new vault with the name specified by the VaultName parameter.

Names can be between 1 and 255 characters long. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).

The region in which the vault is created is controlled 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.)

DeleteArchive Method (AmazonGlacier Class)

Deletes an archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteArchive(const char* lpszVaultName, const char* lpszArchiveId);

Unicode (Windows)
INT DeleteArchive(LPCWSTR lpszVaultName, LPCWSTR lpszArchiveId);

int cloudstorage_amazonglacier_deletearchive(void* lpObj, const char* lpszVaultName, const char* lpszArchiveId);

int DeleteArchive(const QString& qsVaultName, const QString& qsArchiveId);

Remarks

This method deletes the archive specified by the ArchiveId parameter.

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.)

DeleteNotificationInfo Method (AmazonGlacier Class)

Deletes the notification information for the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteNotificationInfo(const char* lpszVaultName);

Unicode (Windows)
INT DeleteNotificationInfo(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_deletenotificationinfo(void* lpObj, const char* lpszVaultName);

int DeleteNotificationInfo(const QString& qsVaultName);

Remarks

This method deletes the notification information associated with the vault specified by VaultName.

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.)

DeleteVault Method (AmazonGlacier Class)

Deletes the specified vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteVault(const char* lpszVaultName);

Unicode (Windows)
INT DeleteVault(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_deletevault(void* lpObj, const char* lpszVaultName);

int DeleteVault(const QString& qsVaultName);

Remarks

This method deletes the vault specified by VaultName. If the vault is not empty Amazon will return an error.

Call GetVaultInfo to get information about the archive including the number of archives it contains.

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 (AmazonGlacier Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int cloudstorage_amazonglacier_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.)

GetJobInfo Method (AmazonGlacier Class)

Retrieves information about the specified job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetJobInfo(const char* lpszVaultName, const char* lpszJobId);

Unicode (Windows)
INT GetJobInfo(LPCWSTR lpszVaultName, LPCWSTR lpszJobId);

int cloudstorage_amazonglacier_getjobinfo(void* lpObj, const char* lpszVaultName, const char* lpszJobId);

int GetJobInfo(const QString& qsVaultName, const QString& qsJobId);

Remarks

This method retrieves information about the job specified by JobId. The Job* properties will be populated with information about the job.

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.)

GetJobOutput Method (AmazonGlacier Class)

Retrieves the output from the job.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetJobOutput(const char* lpszVaultName, const char* lpszJobId);

Unicode (Windows)
INT GetJobOutput(LPCWSTR lpszVaultName, LPCWSTR lpszJobId);

int cloudstorage_amazonglacier_getjoboutput(void* lpObj, const char* lpszVaultName, const char* lpszJobId);

int GetJobOutput(const QString& qsVaultName, const QString& qsJobId);

Remarks

This method retrieves the output from a completed job. If SetDownloadStream has been called the data will be written to the stream. If LocalFile is set, the data will be written to the specified file. If LocalFile is not set the data will be written to either InventoryData or ArchiveData depending on the type of job.

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.)

GetNotificationInfo Method (AmazonGlacier Class)

Retrieves the notification information for the vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotificationInfo(const char* lpszVaultName);

Unicode (Windows)
INT GetNotificationInfo(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_getnotificationinfo(void* lpObj, const char* lpszVaultName);

int GetNotificationInfo(const QString& qsVaultName);

Remarks

This method retrieves the notification information for the vault specified by VaultName. After this method returns, the results will be available in the NotificationInfo* properties.

If no notification settings exist for the vault the class fails with an error.

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.)

GetVaultInfo Method (AmazonGlacier Class)

Retrieves vault details.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVaultInfo(const char* lpszVaultName);

Unicode (Windows)
INT GetVaultInfo(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_getvaultinfo(void* lpObj, const char* lpszVaultName);

int GetVaultInfo(const QString& qsVaultName);

Remarks

This method gets information about the vault specified by VaultName. The Vault* properties will be populated with the results. The following properties are populated:

• VaultArchiveCount
• VaultArn
• VaultCreationDate
• VaultLastInventoryDate
• VaultName
• VaultSize

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 (AmazonGlacier Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudstorage_amazonglacier_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.)

ListJobs Method (AmazonGlacier Class)

Lists the jobs in a vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListJobs(const char* lpszVaultName);

Unicode (Windows)
INT ListJobs(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_listjobs(void* lpObj, const char* lpszVaultName);

int ListJobs(const QString& qsVaultName);

Remarks

This method lists the jobs in the vault specified by VaultName.

The JobList event will fire once for each Job returned. In addition, the Job* properties will be populated.

By default up to 1000 jobs will be returned in a single set of results. The maximum number of results can be specified by setting MaxListJobResults. If the number of results exceeds the maximum the results are paged. The IsJobPaged setting will be set to true and JobMarker will be populated.

To get all results simply call ListJobs again until IsJobPaged returns False and JobMarker is empty string.

Note: The settings JobCompletionFilter and JobStatusFilter may be set to control what type of jobs are 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.)

ListMultipartUploads Method (AmazonGlacier Class)

Lists multipart uploads.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMultipartUploads(const char* lpszVaultName);

Unicode (Windows)
INT ListMultipartUploads(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_listmultipartuploads(void* lpObj, const char* lpszVaultName);

int ListMultipartUploads(const QString& qsVaultName);

Remarks

This method lists the current multipart uploads for the vault specified by VaultName. The MultipartUploadList event will fire once for each multipart upload returned. In addition, the MultipartUpload* properties will be populated.

By default up to 1000 multipart uploads will be returned in a single set of results. The maximum number of results can be specified by setting MaxListMultipartUploadResults. If the number of results exceeds the maximum the results are paged. The IsMultipartUploadPaged setting will be set to true and MultipartUploadMarker will be populated.

To get all results simply call ListMultipartUploads again until IsMultipartUploadPaged returns False and MultipartUploadMarker is empty string.

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 (AmazonGlacier Class)

Lists the parts of a multipart upload.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_amazonglacier_listparts(void* lpObj, const char* lpszVaultName, const char* lpszUploadId);

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

Remarks

This method lists the parts of a multipart upload specified by UploadId.

VaultName identifies the vault in which the archive is created.

The PartList event will fire once for each Part returned. In addition, the Parts* properties will be populated.

By default up to 1000 parts will be returned in a single set of results. The maximum number of results can be specified by setting MaxListPartResults. If the number of results exceeds the maximum the results are paged. The IsPartPaged setting will be set to true and PartMarker will be populated.

To get all results simply call ListParts again until IsPartPaged returns False and PartMarker is empty string.

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.)

ListVaults Method (AmazonGlacier Class)

Lists the vaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListVaults();

Unicode (Windows)
INT ListVaults();

int cloudstorage_amazonglacier_listvaults(void* lpObj);

int ListVaults();

Remarks

This method lists the vaults for an account.

By default up to 1000 vaults will be returned in a single set of results. This maximum number of results can be specified by setting MaxListVaultResults. If the number of results exceeds the maximum the results are paged. The IsVaultPaged setting will be set to true and VaultMarker will be populated.

To get all results simply call ListVaults again until IsVaultPaged returns False and VaultMarker is empty string.

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 (AmazonGlacier Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudstorage_amazonglacier_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.)

SetDownloadStream Method (AmazonGlacier Class)

Sets the stream to which the downloaded data from the server will be written.

Syntax

• C++
• C
• Qt

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

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

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

int SetDownloadStream(CloudStorageStream* sDownloadStream);

Remarks

If a download stream is set before calling GetJobOutput the downloaded data will be written to the stream. The stream should be open and normally set to position 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.)

SetNotificationInfo Method (AmazonGlacier Class)

Sets notification information for a vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetNotificationInfo(const char* lpszVaultName);

Unicode (Windows)
INT SetNotificationInfo(LPCWSTR lpszVaultName);

int cloudstorage_amazonglacier_setnotificationinfo(void* lpObj, const char* lpszVaultName);

int SetNotificationInfo(const QString& qsVaultName);

Remarks

This method sets the notification settings for the vault specified by VaultName. The NotifySNSTopic property must be set before calling this method. Optionally, the NotifyEventType may also be set.

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 (AmazonGlacier Class)

Sets the stream to be uploaded to the server.

Syntax

• C++
• C
• Qt

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

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

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

int SetUploadStream(CloudStorageStream* sUploadStream);

Remarks

If an upload stream is set before calling UploadArchive the data will be read from this stream. The stream should be open and normally set to position 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.)

StartMultipartUpload Method (AmazonGlacier Class)

Starts a multipart upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* StartMultipartUpload(const char* lpszVaultName, const char* lpszArchiveDesc);

Unicode (Windows)
LPWSTR StartMultipartUpload(LPCWSTR lpszVaultName, LPCWSTR lpszArchiveDesc);

char* cloudstorage_amazonglacier_startmultipartupload(void* lpObj, const char* lpszVaultName, const char* lpszArchiveDesc);

QString StartMultipartUpload(const QString& qsVaultName, const QString& qsArchiveDesc);

Remarks

This method initiates a multipart upload operation. Multipart uploads are beneficial in situations where you wish to upload a large amount of data, or do not know how large the data will be when you begin uploading.

This method returns an UploadId that must be saved. This will be used to perform other operations with this upload.

ArchiveDesc may be set to a user friendly description of the archive, or empty string.

VaultName is the vault in which the archive will be created.

The data must be split into parts with a size (in megabytes) specified by PartSize. The part size must be a megabyte multiplied by a power of 2. For instance 1, 2, 4, and 8 are valid sizes. The minimum part size is 1, the maximum is 4096 (4GB). The default value of PartSize is 1.

Each part must be exactly PartSize megabytes in size except the last part. The last part will be smaller. For instance with a part size of 1, uploading a 10.2 megabyte file will have 11 parts. There will be 10 parts of size 1 MB, and 1 part of size .2 MB.

Parts may be uploaded in parallel by using separate class instances. When uploading a part with UploadPart a part number is specified so the data can be properly re-assembled in order when it reaches the server.

After all parts are uploaded call CompleteMultipartUpload to complete the operation. If parts of the archive were uploaded using separate instances of the class you must first list all parts of the archive by calling ListParts until PartMarker is empty (all parts are returned). Information about the parts is required when completing the multipart upload.

To cancel the operation, call AbortMultipartUpload.

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.

UploadArchive Method (AmazonGlacier Class)

Uploads an archive to a vault.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* UploadArchive(const char* lpszVaultName, const char* lpszArchiveDesc);

Unicode (Windows)
LPWSTR UploadArchive(LPCWSTR lpszVaultName, LPCWSTR lpszArchiveDesc);

char* cloudstorage_amazonglacier_uploadarchive(void* lpObj, const char* lpszVaultName, const char* lpszArchiveDesc);

QString UploadArchive(const QString& qsVaultName, const QString& qsArchiveDesc);

Remarks

This method uploads an archive to the vault specified by VaultName. If SetUploadStream was used to specify a valid stream, the archive data will be read from there. If LocalFile is set, the archive data will be read from the specified file. If LocalFile is not set, the data set in ArchiveData will be used.

The ArchiveDesc parameter may be set to a user friendly description of the archive. The description must be less than or equal to 1,024 characters. The allowable characters are 7-bit ASCII without control codes, specifically ASCII values 32-126 decimal or 0x20-0x7E hexadecimal.

This method returns the ArchiveId if the data was successfully uploaded.

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.

UploadPart Method (AmazonGlacier Class)

Uploads a single part in a multipart upload.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_amazonglacier_uploadpart(void* lpObj, const char* lpszVaultName, const char* lpszUploadId, int iPartNumber);

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

Remarks

This method uploads a single part of the multipart upload specified by UploadId.

VaultName is the vault in which the archive is created.

PartNumber identifies this specific part. The first part number is 0. Amazon will re-assemble the archive in the order specified by part numbers.

If SetUploadStream was used to specify a valid stream, the part data will be read from there. If LocalFile is set, the part data will be read from the specified file. If LocalFile is not set, the data set in ArchiveData will be used.

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.)

EndTransfer Event (AmazonGlacier Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_ENDTRANSFER 1

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class AmazonGlacierEndTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireEndTransfer(AmazonGlacierEndTransferEventParams *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 (AmazonGlacier Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_ERROR 2

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

class AmazonGlacierErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireError(AmazonGlacierErrorEventParams *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.

Header Event (AmazonGlacier Class)

This event is fired every time a header line comes in.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_HEADER 3

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

class AmazonGlacierHeaderEventParams {
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(AmazonGlacierHeaderEventParams *e);

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireHeader(AmazonGlacierHeaderEventParams *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).

JobList Event (AmazonGlacier Class)

Fires once for each job returned when calling ListJobs or GetJobInfo.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireJobList(AmazonGlacierJobListEventParams *e);

typedef struct {
  int JobType;
  const char *ArchiveId;
  int64 ArchiveSize;
  const char *ArchiveSHA256TreeHash;
  int Completed;
  const char *CompletionDate;
  const char *CreationDate;
  const char *Description;
  const char *JobId;
  const char *SNSTopic;
  const char *SHA256TreeHash;
  int StatusCode;
  const char *StatusMessage;
  const char *VaultArn;
  int64 InventorySize;
  int reserved;
} AmazonGlacierJobListEventParams;


Unicode (Windows)
virtual INT FireJobList(AmazonGlacierJobListEventParams *e);

typedef struct {
  INT JobType;
  LPCWSTR ArchiveId;
  LONG64 ArchiveSize;
  LPCWSTR ArchiveSHA256TreeHash;
  BOOL Completed;
  LPCWSTR CompletionDate;
  LPCWSTR CreationDate;
  LPCWSTR Description;
  LPCWSTR JobId;
  LPCWSTR SNSTopic;
  LPCWSTR SHA256TreeHash;
  INT StatusCode;
  LPCWSTR StatusMessage;
  LPCWSTR VaultArn;
  LONG64 InventorySize;
  INT reserved;
} AmazonGlacierJobListEventParams;

#define EID_AMAZONGLACIER_JOBLIST 4

virtual INT CLOUDSTORAGE_CALL FireJobList(INT &iJobType, LPSTR &lpszArchiveId, LONG64 &lArchiveSize, LPSTR &lpszArchiveSHA256TreeHash, BOOL &bCompleted, LPSTR &lpszCompletionDate, LPSTR &lpszCreationDate, LPSTR &lpszDescription, LPSTR &lpszJobId, LPSTR &lpszSNSTopic, LPSTR &lpszSHA256TreeHash, INT &iStatusCode, LPSTR &lpszStatusMessage, LPSTR &lpszVaultArn, LONG64 &lInventorySize);

class AmazonGlacierJobListEventParams {
public:
  int JobType();

  const QString &ArchiveId();

  qint64 ArchiveSize();

  const QString &ArchiveSHA256TreeHash();

  bool Completed();

  const QString &CompletionDate();

  const QString &CreationDate();

  const QString &Description();

  const QString &JobId();

  const QString &SNSTopic();

  const QString &SHA256TreeHash();

  int StatusCode();

  const QString &StatusMessage();

  const QString &VaultArn();

  qint64 InventorySize();

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

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

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireJobList(AmazonGlacierJobListEventParams *e) {...}

Remarks

This event fires once for each job returned when calling ListJobs. When calling GetJobInfo this event will fire once since only one job is returned.

JobType indicates the type of job. Possible values are:

ArchiveId is the Id of the archive associated with the job.

ArchiveSize is the size in bytes of the archive.

ArchiveSHA256TreeHash is the SHA256 tree hash of the entire archive for an archive retrieval job.

Completed indicates the status of the job.

CompletionDate is the UTC time that the job completed.

CreationDate is the UTC time that the job was created. This is a string representation of ISO 8601 date format, for example: "2012-03-20T17:03:43.221Z".

Description is the user supplied description. This is specified by the JobDescription setting before calling CreateJob.

JobId is the Amazon assigned Id for the job.

SNSTopic is the Amazon SNS topic that will receive notification about the job status.

SHA256TreeHash is the SHA256 tree hash value for the requested range of an archive. This is only applicable when JobType is 0 (archive retrieval) and a JobRetrievalByteRange is set to a tree-hash aligned range.

StatusCode is the current status of the job. Possible values are:

StatusMessage is a user friendly description of the status.

VaultArn is the Amazon Resource Name (ARN) of the vault from which the archive retrieval or inventory retrieval was requested.

InventorySize is the size in bytes of the inventory data.

Log Event (AmazonGlacier Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_LOG 5

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

class AmazonGlacierLogEventParams {
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(AmazonGlacierLogEventParams *e);

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

Remarks

This event fires 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"

MultipartUploadList Event (AmazonGlacier Class)

Fires once for each multipart upload when ListMultipartUploads is called.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMultipartUploadList(AmazonGlacierMultipartUploadListEventParams *e);

typedef struct {
  const char *ArchiveDescription;
  const char *CreationDate;
  const char *UploadId;
  const char *VaultArn;
  int PartSize;
  int reserved;
} AmazonGlacierMultipartUploadListEventParams;


Unicode (Windows)
virtual INT FireMultipartUploadList(AmazonGlacierMultipartUploadListEventParams *e);

typedef struct {
  LPCWSTR ArchiveDescription;
  LPCWSTR CreationDate;
  LPCWSTR UploadId;
  LPCWSTR VaultArn;
  INT PartSize;
  INT reserved;
} AmazonGlacierMultipartUploadListEventParams;

#define EID_AMAZONGLACIER_MULTIPARTUPLOADLIST 6

virtual INT CLOUDSTORAGE_CALL FireMultipartUploadList(LPSTR &lpszArchiveDescription, LPSTR &lpszCreationDate, LPSTR &lpszUploadId, LPSTR &lpszVaultArn, INT &iPartSize);

class AmazonGlacierMultipartUploadListEventParams {
public:
  const QString &ArchiveDescription();

  const QString &CreationDate();

  const QString &UploadId();

  const QString &VaultArn();

  int PartSize();

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

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

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireMultipartUploadList(AmazonGlacierMultipartUploadListEventParams *e) {...}

Remarks

This event fires for each multipart upload returned when calling ListMultipartUploads.

ArchiveDescription is the archive description (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

PartSize is the part size in bytes. This is specified by the PartSize setting and is used when StartMultipartUpload is called.

PartList Event (AmazonGlacier Class)

Fires once for each part when calling ListParts.

Syntax

• C++
• C
• Qt

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

typedef struct {
  const char *ArchiveDescription;
  const char *CreationDate;
  const char *UploadId;
  int64 StartPosition;
  int64 Size;
  const char *SHA256TreeHash;
  const char *VaultArn;
  int reserved;
} AmazonGlacierPartListEventParams;


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

typedef struct {
  LPCWSTR ArchiveDescription;
  LPCWSTR CreationDate;
  LPCWSTR UploadId;
  LONG64 StartPosition;
  LONG64 Size;
  LPCWSTR SHA256TreeHash;
  LPCWSTR VaultArn;
  INT reserved;
} AmazonGlacierPartListEventParams;

#define EID_AMAZONGLACIER_PARTLIST 7

virtual INT CLOUDSTORAGE_CALL FirePartList(LPSTR &lpszArchiveDescription, LPSTR &lpszCreationDate, LPSTR &lpszUploadId, LONG64 &lStartPosition, LONG64 &lSize, LPSTR &lpszSHA256TreeHash, LPSTR &lpszVaultArn);

class AmazonGlacierPartListEventParams {
public:
  const QString &ArchiveDescription();

  const QString &CreationDate();

  const QString &UploadId();

  qint64 StartPosition();

  qint64 Size();

  const QString &SHA256TreeHash();

  const QString &VaultArn();

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

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

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

Remarks

This event fires once for each part when calling ListParts.

ArchiveDescription is the description of the archive (if any).

CreationDate is the UTC time that the multipart upload was started. This is a string representation of ISO 8601 date format. For example: "2012-03-20T17:03:43.221Z".

UploadId is the Id of the multipart upload associated with this part.

StartPosition is the byte offset in the archive of the current part.

Size is the part size in bytes.

SHA256TreeHash is the SHA256 tree hash value that Amazon calculated for the part.

VaultArn is the Amazon Resource Name (ARN) of the Vault in which the archive is created.

Progress Event (AmazonGlacier Class)

Fires during an upload or download to indicate transfer progress.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_PROGRESS 8

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

class AmazonGlacierProgressEventParams {
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(AmazonGlacierProgressEventParams *e);

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireProgress(AmazonGlacierProgressEventParams *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 (AmazonGlacier Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_SSLSERVERAUTHENTICATION 9

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

class AmazonGlacierSSLServerAuthenticationEventParams {
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(AmazonGlacierSSLServerAuthenticationEventParams *e);

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireSSLServerAuthentication(AmazonGlacierSSLServerAuthenticationEventParams *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 (AmazonGlacier Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_SSLSTATUS 10

virtual INT CLOUDSTORAGE_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartTransfer Event (AmazonGlacier Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_STARTTRANSFER 11

virtual INT CLOUDSTORAGE_CALL FireStartTransfer(INT &iDirection);

class AmazonGlacierStartTransferEventParams {
public:
  int Direction();

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

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

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireStartTransfer(AmazonGlacierStartTransferEventParams *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 (AmazonGlacier Class)

This event is fired while a document transfers (delivers document).

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AMAZONGLACIER_TRANSFER 12

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

class AmazonGlacierTransferEventParams {
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(AmazonGlacierTransferEventParams *e);

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireTransfer(AmazonGlacierTransferEventParams *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.

VaultList Event (AmazonGlacier Class)

Fires once for each vault returned when calling ListVaults.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireVaultList(AmazonGlacierVaultListEventParams *e);

typedef struct {
  const char *CreationDate;
  const char *LastInventoryDate;
  const char *VaultArn;
  const char *VaultName;
  int ArchiveCount;
  int64 Size;
  int reserved;
} AmazonGlacierVaultListEventParams;


Unicode (Windows)
virtual INT FireVaultList(AmazonGlacierVaultListEventParams *e);

typedef struct {
  LPCWSTR CreationDate;
  LPCWSTR LastInventoryDate;
  LPCWSTR VaultArn;
  LPCWSTR VaultName;
  INT ArchiveCount;
  LONG64 Size;
  INT reserved;
} AmazonGlacierVaultListEventParams;

#define EID_AMAZONGLACIER_VAULTLIST 13

virtual INT CLOUDSTORAGE_CALL FireVaultList(LPSTR &lpszCreationDate, LPSTR &lpszLastInventoryDate, LPSTR &lpszVaultArn, LPSTR &lpszVaultName, INT &iArchiveCount, LONG64 &lSize);

class AmazonGlacierVaultListEventParams {
public:
  const QString &CreationDate();

  const QString &LastInventoryDate();

  const QString &VaultArn();

  const QString &VaultName();

  int ArchiveCount();

  qint64 Size();

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

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

// Or, subclass AmazonGlacier and override this emitter function.
virtual int FireVaultList(AmazonGlacierVaultListEventParams *e) {...}

Remarks

This event fires once for each vault returned when calling ListVaults.

CreationDate is the date the vault was created, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

LastInventoryDate is the date of the last vault inventory, in Coordinated Universal Time (UTC). This is a string representation of ISO 8601 date format, for example: 2012-03-20T17:03:43.221Z.

VaultArn is the Amazon Resource Name (ARN) of the vault.

VaultName is the name of the vault.

ArchiveCount is the number of archives in the vault as of LastInventoryDate.

Size is the size of all the archives (including any per-archive overhead) in the vault, as of the last inventory date.

CloudStorageStream Type

Syntax

CloudStorageStream (declared in cloudstorage.h)

Remarks

The AmazonGlacier class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the CloudStorageStream interface and pass the AmazonGlacier class an instance of that concrete class.

When implementing the CloudStorageStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }