IBMStorage Class

Properties   Methods   Events   Config Settings   Errors  

The IBMStorage class provides an easy way to interface with IBM Cloud's Object Storage service.

Syntax

IBMStorage

Remarks

The IBM Cloud Object Storage service has an API that is compatible with that of Amazon S3, allowing you to store arbitrary data using the same bucket-and-object paradigm that S3 uses.

To use the IBMStorage class, you will first need to sign up for the IBM Cloud Object Storage service and obtain an AccessKey and a SecretKey. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.

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

Property List

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

Method List

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

Event List

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

Config Settings

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

AccessKey Property (IBMStorage 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_ibmstorage_getaccesskey(void* lpObj);
int cloudstorage_ibmstorage_setaccesskey(void* lpObj, const char* lpszAccessKey);

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

Default Value

""

Remarks

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

Data Type

String

AccessPolicy Property (IBMStorage Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_ibmstorage_getaccesspolicy(void* lpObj);
int cloudstorage_ibmstorage_setaccesspolicy(void* lpObj, int iAccessPolicy);

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

Default Value

0

Remarks

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

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

Valid values are:

Data Type

Integer

Bucket Property (IBMStorage Class)

Selects a bucket.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getbucket(void* lpObj);
int cloudstorage_ibmstorage_setbucket(void* lpObj, const char* lpszBucket);

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

Default Value

""

Remarks

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

Data Type

String

BucketsCount Property (IBMStorage Class)

The number of records in the Buckets arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBucketsCount();

Unicode (Windows)
INT GetBucketsCount();

int cloudstorage_ibmstorage_getbucketscount(void* lpObj);

int GetBucketsCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• BucketsCreationDate
• BucketsName
• BucketsOwnerDisplayName
• BucketsOwnerId

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

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

Data Type

Integer

BucketsCreationDate Property (IBMStorage Class)

The property includes the creation date of the bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBucketsCreationDate(int iBucketsIndex);

Unicode (Windows)
LPWSTR GetBucketsCreationDate(INT iBucketsIndex);

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

QString GetBucketsCreationDate(int iBucketsIndex);

Default Value

""

Remarks

The property includes the creation date of the bucket.

This property reflects the creation date of the bucket.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

BucketsName Property (IBMStorage Class)

The property contains the name of the bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBucketsName(int iBucketsIndex);

Unicode (Windows)
LPWSTR GetBucketsName(INT iBucketsIndex);

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

QString GetBucketsName(int iBucketsIndex);

Default Value

""

Remarks

The property contains the name of the bucket.

This property reflects the name of the bucket.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

BucketsOwnerDisplayName Property (IBMStorage Class)

The property contains the display name of the bucket's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBucketsOwnerDisplayName(int iBucketsIndex);

Unicode (Windows)
LPWSTR GetBucketsOwnerDisplayName(INT iBucketsIndex);

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

QString GetBucketsOwnerDisplayName(int iBucketsIndex);

Default Value

""

Remarks

The property contains the display name of the bucket's owner.

This property reflects the display name of the bucket's owner.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

BucketsOwnerId Property (IBMStorage Class)

The property contains the Id of the bucket's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBucketsOwnerId(int iBucketsIndex);

Unicode (Windows)
LPWSTR GetBucketsOwnerId(INT iBucketsIndex);

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

QString GetBucketsOwnerId(int iBucketsIndex);

Default Value

""

Remarks

The property contains the Id of the bucket's owner.

This property reflects the Id of the bucket's owner.

The BucketsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

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

Data Type

String

ContentDisposition Property (IBMStorage Class)

Content disposition to send for an object.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getcontentdisposition(void* lpObj);
int cloudstorage_ibmstorage_setcontentdisposition(void* lpObj, const char* lpszContentDisposition);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ContentType Property (IBMStorage Class)

Content type to send for an object.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getcontenttype(void* lpObj);
int cloudstorage_ibmstorage_setcontenttype(void* lpObj, const char* lpszContentType);

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (IBMStorage 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_ibmstorage_getencryptionalgorithm(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getencryptionpassword(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getfirewallautodetect(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getfirewalltype(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getfirewallhost(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getfirewallpassword(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getfirewallport(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getfirewalluser(void* lpObj);
int cloudstorage_ibmstorage_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

FollowRedirects Property (IBMStorage Class)

Determines what happens when the server issues a redirect.

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_ibmstorage_getfollowredirects(void* lpObj);
int cloudstorage_ibmstorage_setfollowredirects(void* lpObj, int iFollowRedirects);

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

Default Value

0

Remarks

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

Data Type

Integer

Idle Property (IBMStorage Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_ibmstorage_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

LocalFile Property (IBMStorage Class)

The location of the local file.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getlocalfile(void* lpObj);
wchar_t* cloudstorage_ibmstorage_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_ibmstorage_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_ibmstorage_setlocalfile(void* lpObj, const wchar_t* lpszLocalFile); // Windows only

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

Default Value

""

Remarks

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

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

Data Type

String

LocalHost Property (IBMStorage 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_ibmstorage_getlocalhost(void* lpObj);
int cloudstorage_ibmstorage_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

MetadataCount Property (IBMStorage Class)

The number of records in the Metadata arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetMetadataCount();
int SetMetadataCount(int iMetadataCount);

Unicode (Windows)
INT GetMetadataCount();
INT SetMetadataCount(INT iMetadataCount);

int cloudstorage_ibmstorage_getmetadatacount(void* lpObj);
int cloudstorage_ibmstorage_setmetadatacount(void* lpObj, int iMetadataCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

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

This property is not available at design time.

Data Type

Integer

MetadataName Property (IBMStorage Class)

The property contains the name of the metadata item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMetadataName(int iMetadataIndex);
int SetMetadataName(int iMetadataIndex, const char* lpszMetadataName);

Unicode (Windows)
LPWSTR GetMetadataName(INT iMetadataIndex);
INT SetMetadataName(INT iMetadataIndex, LPCWSTR lpszMetadataName);

char* cloudstorage_ibmstorage_getmetadataname(void* lpObj, int metadataindex);
int cloudstorage_ibmstorage_setmetadataname(void* lpObj, int metadataindex, const char* lpszMetadataName);

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

Default Value

""

Remarks

The property contains the name of the metadata item.

This property specifies the name of the metadata item. The server stores metadata names in lowercase.

Note: The class will automatically prepend the service-appropriate prefix (e.g., x-amz-meta-, x-goog-meta-) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated.

The MetadataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

MetadataValue Property (IBMStorage Class)

This property contains the value of the metadata item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMetadataValue(int iMetadataIndex);
int SetMetadataValue(int iMetadataIndex, const char* lpszMetadataValue);

Unicode (Windows)
LPWSTR GetMetadataValue(INT iMetadataIndex);
INT SetMetadataValue(INT iMetadataIndex, LPCWSTR lpszMetadataValue);

char* cloudstorage_ibmstorage_getmetadatavalue(void* lpObj, int metadataindex);
int cloudstorage_ibmstorage_setmetadatavalue(void* lpObj, int metadataindex, const char* lpszMetadataValue);

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

Default Value

""

Remarks

This property contains the value of the metadata item.

This property specifies the value of the metadata item.

The MetadataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

ObjectData Property (IBMStorage Class)

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

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_ibmstorage_getobjectdata(void* lpObj, char** lpObjectData, int* lenObjectData);
int cloudstorage_ibmstorage_setobjectdata(void* lpObj, const char* lpObjectData, int lenObjectData);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

ObjectDelimiter Property (IBMStorage Class)

The delimiter string to use when listing objects.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getobjectdelimiter(void* lpObj);
int cloudstorage_ibmstorage_setobjectdelimiter(void* lpObj, const char* lpszObjectDelimiter);

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

Default Value

""

Remarks

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

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

Object Hierarchy Traversal

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

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

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

This property is not available at design time.

Data Type

String

ObjectMarker Property (IBMStorage Class)

A marker indicating what page of objects to return next.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getobjectmarker(void* lpObj);
int cloudstorage_ibmstorage_setobjectmarker(void* lpObj, const char* lpszObjectMarker);

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

Default Value

""

Remarks

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

Refer to ListObjects for more information.

This property is not available at design time.

Data Type

String

ObjectPrefix Property (IBMStorage Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getobjectprefix(void* lpObj);
int cloudstorage_ibmstorage_setobjectprefix(void* lpObj, const char* lpszObjectPrefix);

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

Default Value

""

Remarks

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

Object Hierarchy Traversal

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

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

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

This property is not available at design time.

Data Type

String

ObjectsCount Property (IBMStorage Class)

The number of records in the Objects arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjectsCount();

Unicode (Windows)
INT GetObjectsCount();

int cloudstorage_ibmstorage_getobjectscount(void* lpObj);

int GetObjectsCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjectsDeleted
• ObjectsETag
• ObjectsLastModified
• ObjectsLatestVersion
• ObjectsName
• ObjectsOwnerDisplayName
• ObjectsOwnerId
• ObjectsSize
• ObjectsStorageClass
• ObjectsUploadId
• ObjectsVersionId

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

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

Data Type

Integer

ObjectsDeleted Property (IBMStorage Class)

This property specifies whether this object version is a delete marker.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjectsDeleted(int iObjectsIndex);

Unicode (Windows)
BOOL GetObjectsDeleted(INT iObjectsIndex);

int cloudstorage_ibmstorage_getobjectsdeleted(void* lpObj, int objectsindex);

bool GetObjectsDeleted(int iObjectsIndex);

Default Value

FALSE

Remarks

This property specifies whether this object version is a delete marker.

This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to DeleteObject for more information.

This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; false in all other cases.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

Boolean

ObjectsETag Property (IBMStorage Class)

This property contains the ETag of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsETag(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsETag(INT iObjectsIndex);

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

QString GetObjectsETag(int iObjectsIndex);

Default Value

""

Remarks

This property contains the ETag of the object.

This property reflects the ETag of the object.

An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified.

This is not applicable when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsLastModified Property (IBMStorage Class)

This property contains the last modified time of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsLastModified(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsLastModified(INT iObjectsIndex);

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

QString GetObjectsLastModified(int iObjectsIndex);

Default Value

""

Remarks

This property contains the last modified time of the object.

This property reflects the last modified time of the object.

This is not applicable when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsLatestVersion Property (IBMStorage Class)

This property specifies whether this is the latest object version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetObjectsLatestVersion(int iObjectsIndex);

Unicode (Windows)
BOOL GetObjectsLatestVersion(INT iObjectsIndex);

int cloudstorage_ibmstorage_getobjectslatestversion(void* lpObj, int objectsindex);

bool GetObjectsLatestVersion(int iObjectsIndex);

Default Value

TRUE

Remarks

This property specifies whether this is the latest object version.

This property indicates whether this object version is the latest version available.

This is applicable only when ListVersions is called.; true in all other cases.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

Boolean

ObjectsName Property (IBMStorage Class)

This property contains the name (key) of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsName(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsName(INT iObjectsIndex);

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

QString GetObjectsName(int iObjectsIndex);

Default Value

""

Remarks

This property contains the name (key) of the object.

This property reflects the name (key) of the object.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsOwnerDisplayName Property (IBMStorage Class)

This property contains the display name of the object's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsOwnerDisplayName(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsOwnerDisplayName(INT iObjectsIndex);

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

QString GetObjectsOwnerDisplayName(int iObjectsIndex);

Default Value

""

Remarks

This property contains the display name of the object's owner.

This property reflects the display name of the object's owner.

This is not applicable when GetObjectInfo is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsOwnerId Property (IBMStorage Class)

This property contains the Id of the object's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsOwnerId(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsOwnerId(INT iObjectsIndex);

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

QString GetObjectsOwnerId(int iObjectsIndex);

Default Value

""

Remarks

This property contains the Id of the object's owner.

This property reflects the Id of the object's owner.

This is not applicable when GetObjectInfo is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsSize Property (IBMStorage Class)

This property contains the size of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetObjectsSize(int iObjectsIndex);

Unicode (Windows)
LONG64 GetObjectsSize(INT iObjectsIndex);

int64 cloudstorage_ibmstorage_getobjectssize(void* lpObj, int objectsindex);

qint64 GetObjectsSize(int iObjectsIndex);

Default Value

0

Remarks

This property contains the size of the object.

This property reflects the size of the object in bytes.

This is not applicable when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

Long64

ObjectsStorageClass Property (IBMStorage Class)

This property contains the storage class of the object.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsStorageClass(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsStorageClass(INT iObjectsIndex);

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

QString GetObjectsStorageClass(int iObjectsIndex);

Default Value

""

Remarks

This property contains the storage class of the object.

This property reflects the storage class of the object.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsUploadId Property (IBMStorage Class)

This property contains the upload Id of the multipart upload.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsUploadId(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsUploadId(INT iObjectsIndex);

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

QString GetObjectsUploadId(int iObjectsIndex);

Default Value

""

Remarks

This property contains the upload Id of the multipart upload.

This property reflects the upload Id of the multipart upload.

It is applicable only when ListMultipartUploads is called.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

ObjectsVersionId Property (IBMStorage Class)

This property contains the Id of the object version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetObjectsVersionId(int iObjectsIndex);

Unicode (Windows)
LPWSTR GetObjectsVersionId(INT iObjectsIndex);

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

QString GetObjectsVersionId(int iObjectsIndex);

Default Value

""

Remarks

This property contains the Id of the object version.

This property reflects the Id of the object version.

Note: The string null is a valid version Id.

This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; empty in all other cases.

The ObjectsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

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

Data Type

String

OtherHeaders Property (IBMStorage 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_ibmstorage_getotherheaders(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage Class)

Determines if local files are overwritten.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_ibmstorage_getoverwrite(void* lpObj);
int cloudstorage_ibmstorage_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (IBMStorage Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_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 (IBMStorage 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_ibmstorage_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 (IBMStorage Class)

A marker indicating what page of parts to return next.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getpartmarker(void* lpObj);
int cloudstorage_ibmstorage_setpartmarker(void* lpObj, const char* lpszPartMarker);

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

Default Value

""

Remarks

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

Refer to ListParts for more information.

This property is not available at design time.

Data Type

String

PartsCount Property (IBMStorage Class)

The number of records in the Parts arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPartsCount();

Unicode (Windows)
INT GetPartsCount();

int cloudstorage_ibmstorage_getpartscount(void* lpObj);

int GetPartsCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartsETag
• PartsLastModified
• PartsNumber
• PartsObjectName
• PartsOwnerDisplayName
• PartsOwnerId
• PartsSize

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

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

Data Type

Integer

PartsETag Property (IBMStorage Class)

This property contains the ETag of the part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartsETag(int iPartsIndex);

Unicode (Windows)
LPWSTR GetPartsETag(INT iPartsIndex);

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

QString GetPartsETag(int iPartsIndex);

Default Value

""

Remarks

This property contains the ETag of the part.

This property reflects the ETag of the part.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsLastModified Property (IBMStorage Class)

This property contains the last modified time of the part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartsLastModified(int iPartsIndex);

Unicode (Windows)
LPWSTR GetPartsLastModified(INT iPartsIndex);

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

QString GetPartsLastModified(int iPartsIndex);

Default Value

""

Remarks

This property contains the last modified time of the part.

This property reflects the last modified time of the part.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsObjectName Property (IBMStorage Class)

This property contains the name (key) of the object that the part was uploaded for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartsObjectName(int iPartsIndex);

Unicode (Windows)
LPWSTR GetPartsObjectName(INT iPartsIndex);

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

QString GetPartsObjectName(int iPartsIndex);

Default Value

""

Remarks

This property contains the name (key) of the object that the part was uploaded for.

This property reflects the name (key) of the object that the part was uploaded for.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsOwnerDisplayName Property (IBMStorage Class)

This property contains the display name of the part's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartsOwnerDisplayName(int iPartsIndex);

Unicode (Windows)
LPWSTR GetPartsOwnerDisplayName(INT iPartsIndex);

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

QString GetPartsOwnerDisplayName(int iPartsIndex);

Default Value

""

Remarks

This property contains the display name of the part's owner.

This property reflects the display name of the part's owner.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsOwnerId Property (IBMStorage Class)

This property contains the Id of the part's owner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartsOwnerId(int iPartsIndex);

Unicode (Windows)
LPWSTR GetPartsOwnerId(INT iPartsIndex);

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

QString GetPartsOwnerId(int iPartsIndex);

Default Value

""

Remarks

This property contains the Id of the part's owner.

This property reflects the Id of the part's owner.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

String

PartsNumber Property (IBMStorage Class)

This property contains the number of the part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPartsNumber(int iPartsIndex);

Unicode (Windows)
INT GetPartsNumber(INT iPartsIndex);

int cloudstorage_ibmstorage_getpartsnumber(void* lpObj, int partsindex);

int GetPartsNumber(int iPartsIndex);

Default Value

0

Remarks

This property contains the number of the part.

This property reflects the number of the part.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

Integer

PartsSize Property (IBMStorage Class)

This property contains the size of the part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPartsSize(int iPartsIndex);

Unicode (Windows)
LONG64 GetPartsSize(INT iPartsIndex);

int64 cloudstorage_ibmstorage_getpartssize(void* lpObj, int partsindex);

qint64 GetPartsSize(int iPartsIndex);

Default Value

0

Remarks

This property contains the size of the part.

This property reflects the size of the part in bytes.

The PartsIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

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

Data Type

Long64

ProxyAuthScheme Property (IBMStorage 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_ibmstorage_getproxyauthscheme(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getproxyautodetect(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getproxypassword(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getproxyport(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getproxyserver(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getproxyssl(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage Class)

This property contains a user name, 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_ibmstorage_getproxyuser(void* lpObj);
int cloudstorage_ibmstorage_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

This property contains a user name, 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

QueryParamCount Property (IBMStorage Class)

The number of records in the QueryParam arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetQueryParamCount();
int SetQueryParamCount(int iQueryParamCount);

Unicode (Windows)
INT GetQueryParamCount();
INT SetQueryParamCount(INT iQueryParamCount);

int cloudstorage_ibmstorage_getqueryparamcount(void* lpObj);
int cloudstorage_ibmstorage_setqueryparamcount(void* lpObj, int iQueryParamCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

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

This property is not available at design time.

Data Type

Integer

QueryParamName Property (IBMStorage Class)

The name of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamName(int iQueryParamIndex);
int SetQueryParamName(int iQueryParamIndex, const char* lpszQueryParamName);

Unicode (Windows)
LPWSTR GetQueryParamName(INT iQueryParamIndex);
INT SetQueryParamName(INT iQueryParamIndex, LPCWSTR lpszQueryParamName);

char* cloudstorage_ibmstorage_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_ibmstorage_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

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

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (IBMStorage Class)

The value of the query parameter.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetQueryParamValue(int iQueryParamIndex);
int SetQueryParamValue(int iQueryParamIndex, const char* lpszQueryParamValue);

Unicode (Windows)
LPWSTR GetQueryParamValue(INT iQueryParamIndex);
INT SetQueryParamValue(INT iQueryParamIndex, LPCWSTR lpszQueryParamValue);

char* cloudstorage_ibmstorage_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_ibmstorage_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

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

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

Range Property (IBMStorage Class)

The range of bytes to request.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getrange(void* lpObj);
int cloudstorage_ibmstorage_setrange(void* lpObj, const char* lpszRange);

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

Default Value

""

Remarks

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

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

• StartByte-
• StartByte-EndByte

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

This property is not available at design time.

Data Type

String

Region Property (IBMStorage 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_ibmstorage_getregion(void* lpObj);
int cloudstorage_ibmstorage_setregion(void* lpObj, const char* lpszRegion);

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

Default Value

"us"

Remarks

This property control which region the class will make requests against. By default the class uses us, the US cross region. This property should be changed to create or access resources in other regions.

Regions:

Note that private. or direct. may optionally be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.

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 (IBMStorage 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_ibmstorage_getsecretkey(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_ibmstorage_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 are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IBMStorage 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_ibmstorage_getsslcertstorepassword(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getsslcertstoretype(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_getsslcertsubject(void* lpObj);
int cloudstorage_ibmstorage_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 displayed below.

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

Data Type

String

SSLProvider Property (IBMStorage 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_ibmstorage_getsslprovider(void* lpObj);
int cloudstorage_ibmstorage_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 (IBMStorage 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_ibmstorage_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

StartByte Property (IBMStorage Class)

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

Syntax

• C++
• C
• Qt

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

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

int64 cloudstorage_ibmstorage_getstartbyte(void* lpObj);
int cloudstorage_ibmstorage_setstartbyte(void* lpObj, int64 lStartByte);

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

Default Value

0

Remarks

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

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

This property is not available at design time.

Data Type

Long64

Timeout Property (IBMStorage 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_ibmstorage_gettimeout(void* lpObj);
int cloudstorage_ibmstorage_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

UseVirtualHosting Property (IBMStorage Class)

Determines which style request to use.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_ibmstorage_getusevirtualhosting(void* lpObj);
int cloudstorage_ibmstorage_setusevirtualhosting(void* lpObj, int bUseVirtualHosting);

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

Default Value

TRUE

Remarks

If set to true (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.s3.us.cloud-object-storage.appdomain.cloud/yourobject. If false, the class will use the path-style request: http://s3.us.cloud-object-storage.appdomain.cloud/yourbucket/yourobject.

Note: When set to true, there are more limitations when choosing a bucket name due to DNS server naming restrictions.

This property is not available at design time.

Data Type

Boolean

VersionId Property (IBMStorage Class)

The object version to make requests against.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getversionid(void* lpObj);
int cloudstorage_ibmstorage_setversionid(void* lpObj, const char* lpszVersionId);

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

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

VersioningEnabled Property (IBMStorage Class)

Controls whether versioning is enabled for the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetVersioningEnabled();
int SetVersioningEnabled(int bVersioningEnabled);

Unicode (Windows)
BOOL GetVersioningEnabled();
INT SetVersioningEnabled(BOOL bVersioningEnabled);

int cloudstorage_ibmstorage_getversioningenabled(void* lpObj);
int cloudstorage_ibmstorage_setversioningenabled(void* lpObj, int bVersioningEnabled);

bool GetVersioningEnabled();
int SetVersioningEnabled(bool bVersioningEnabled);

Default Value

FALSE

Remarks

This property can be used to query and control whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this property will always return false when queried, and any attempts to set it will fail.

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

This property is not available at design time.

Data Type

Boolean

VersionMarker Property (IBMStorage Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_ibmstorage_getversionmarker(void* lpObj);
int cloudstorage_ibmstorage_setversionmarker(void* lpObj, const char* lpszVersionMarker);

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

Default Value

""

Remarks

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

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AbortMultipartUpload Method (IBMStorage Class)

Aborts a multipart upload.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

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

Error Handling (C++)

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

AddMetadata Method (IBMStorage Class)

Adds a metadata item to the Metadata properties.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

Error Handling (C++)

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

AddQueryParam Method (IBMStorage Class)

Adds a query parameter to the QueryParams properties.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

Error Handling (C++)

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

BucketExists Method (IBMStorage Class)

Checks whether the bucket exists.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int BucketExists();

Unicode (Windows)
INT BucketExists();

int cloudstorage_ibmstorage_bucketexists(void* lpObj);

bool BucketExists();

Remarks

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

Error Handling (C++)

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

CheckVersioningEnabled Method (IBMStorage Class)

Checks whether versioning is enabled for the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CheckVersioningEnabled();

Unicode (Windows)
INT CheckVersioningEnabled();

int cloudstorage_ibmstorage_checkversioningenabled(void* lpObj);

bool CheckVersioningEnabled();

Remarks

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

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

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

Error Handling (C++)

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

CompleteMultipartUpload Method (IBMStorage Class)

Completes a multipart upload by assembling previously uploaded parts.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

Error Handling (C++)

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

Config Method (IBMStorage 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_ibmstorage_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

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

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

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

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

Error Handling (C++)

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

CopyObject Method (IBMStorage Class)

Copies an object.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

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

Notes:

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

Error Handling (C++)

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

CopyPart Method (IBMStorage Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

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

Error Handling (C++)

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

CreateBucket Method (IBMStorage Class)

Creates a new bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateBucket();

Unicode (Windows)
INT CreateBucket();

int cloudstorage_ibmstorage_createbucket(void* lpObj);

int CreateBucket();

Remarks

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

Error Handling (C++)

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

CreateObject Method (IBMStorage Class)

Creates a new object in the currently selected bucket.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT CreateObject(LPCWSTR lpszObjectName);

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

int CreateObject(const QString& qsObjectName);

Remarks

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

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

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

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

Automatic Multipart Uploads

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

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

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

Error Handling (C++)

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

DeleteBucket Method (IBMStorage Class)

Deletes a bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteBucket();

Unicode (Windows)
INT DeleteBucket();

int cloudstorage_ibmstorage_deletebucket(void* lpObj);

int DeleteBucket();

Remarks

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

Error Handling (C++)

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

DeleteObject Method (IBMStorage Class)

Deletes an object.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT DeleteObject(LPCWSTR lpszObjectName);

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

int DeleteObject(const QString& qsObjectName);

Remarks

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

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

Deleting Versioned Objects

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

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

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

Error Handling (C++)

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

DisableVersioning Method (IBMStorage Class)

Disables versioning for the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DisableVersioning();

Unicode (Windows)
INT DisableVersioning();

int cloudstorage_ibmstorage_disableversioning(void* lpObj);

int DisableVersioning();

Remarks

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

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

Error Handling (C++)

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

DoEvents Method (IBMStorage Class)

Processes events from the internal message queue.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DoEvents();

Unicode (Windows)
INT DoEvents();

int cloudstorage_ibmstorage_doevents(void* lpObj);

int DoEvents();

Remarks

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

Error Handling (C++)

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

EnableVersioning Method (IBMStorage Class)

Enables versioning for the currently selected bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int EnableVersioning();

Unicode (Windows)
INT EnableVersioning();

int cloudstorage_ibmstorage_enableversioning(void* lpObj);

int EnableVersioning();

Remarks

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

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

Error Handling (C++)

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

GetBucketLocation Method (IBMStorage Class)

Gets a bucket's location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBucketLocation();

Unicode (Windows)
LPWSTR GetBucketLocation();

char* cloudstorage_ibmstorage_getbucketlocation(void* lpObj);

QString GetBucketLocation();

Remarks

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

Error Handling (C++)

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

GetLink Method (IBMStorage Class)

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

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

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

Error Handling (C++)

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

GetObject Method (IBMStorage Class)

Downloads an object.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetObject(LPCWSTR lpszObjectName);

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

int GetObject(const QString& qsObjectName);

Remarks

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

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

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

Download Notes

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

Resuming Downloads

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

Resuming Encrypted File Downloads

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

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

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

Error Handling (C++)

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

GetObjectInfo Method (IBMStorage Class)

Gets an object's information and metadata.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
INT GetObjectInfo(LPCWSTR lpszObjectName);

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

int GetObjectInfo(const QString& qsObjectName);

Remarks

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

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

Error Handling (C++)

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

Interrupt Method (IBMStorage Class)

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

int cloudstorage_ibmstorage_interrupt(void* lpObj);

int Interrupt();

Remarks

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

Error Handling (C++)

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

ListBuckets Method (IBMStorage Class)

Lists all buckets in the account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListBuckets();

Unicode (Windows)
INT ListBuckets();

int cloudstorage_ibmstorage_listbuckets(void* lpObj);

int ListBuckets();

Remarks

This method lists all buckets in the account.

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

Error Handling (C++)

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

ListMultipartUploads Method (IBMStorage Class)

Lists the current multipart uploads.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListMultipartUploads();

Unicode (Windows)
INT ListMultipartUploads();

int cloudstorage_ibmstorage_listmultipartuploads(void* lpObj);

int ListMultipartUploads();

Remarks

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

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

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

If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

Error Handling (C++)

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

ListObjects Method (IBMStorage Class)

Lists the objects in a bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListObjects();

Unicode (Windows)
INT ListObjects();

int cloudstorage_ibmstorage_listobjects(void* lpObj);

int ListObjects();

Remarks

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

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

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

If there are still more objects available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

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

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

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

Error Handling (C++)

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

ListParts Method (IBMStorage Class)

Lists the parts in a multipart upload.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

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

If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts* properties.

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

Error Handling (C++)

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

ListVersions Method (IBMStorage Class)

Lists the object versions in a bucket.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListVersions();

Unicode (Windows)
INT ListVersions();

int cloudstorage_ibmstorage_listversions(void* lpObj);

int ListVersions();

Remarks

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

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

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

If there are still more object versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

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

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

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

Error Handling (C++)

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

Reset Method (IBMStorage Class)

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int cloudstorage_ibmstorage_reset(void* lpObj);

int Reset();

Remarks

This method resets the class to its initial state.

Error Handling (C++)

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

ResetHeaders Method (IBMStorage Class)

Resets all HTTP headers, cookies, and LocalFile.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResetHeaders();

Unicode (Windows)
INT ResetHeaders();

int cloudstorage_ibmstorage_resetheaders(void* lpObj);

int ResetHeaders();

Remarks

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

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

Error Handling (C++)

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

SendCustomRequest Method (IBMStorage Class)

Sends a custom request to the server.

Syntax

• C++
• C
• Qt

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

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

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

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

Remarks

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

Valid values for HttpMethod are:

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

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