AzureBlob Class

Properties   Methods   Events   Config Settings   Errors  

The AzureBlob class provides an easy to use interface to Microsoft's Azure Blob Storage service.

Syntax

AzureBlob

Remarks

The AzureBlob class offers an easy-to-use API for the Microsoft Azure Blob Storage service. Capabilities include uploading and downloading blobs of all types, strong encryption support, container management, and more.

Authentication

Authentication is simple, set the Account property to the name of the Azure Storage account to operate against, and set the AccessKey property to an Azure access key associated with that account.

Alternatively, this class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property to set the appropriate fields for the chosen OAuthClientProfile and OAuthGrantType. Typically, the following fields should be set to the below values:

Below is a brief description of the different ClientProfile and GrantType values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the Authorize method should be called. If the authorization and authentication was successful, then the AccessToken field will be populated. Additionally, if a refresh token was provided the RefreshToken field will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the AccessToken will be expired. When a method that makes requests to the service provider is called or the Authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new AccessToken. If the Authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the GrantType field. To force the component to only check the access token when the Authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the GrantType field are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this GrantType the class expects a ClientId, ClientSecret, ServerAuthURL, and ServerTokenURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the AuthorizationCode field, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the RefreshToken field is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

blob.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; blob.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; blob.OAuth.ClientId = CLIENT_ID; blob.OAuth.ClientSecret = CLIENT_SECRET; blob.OAuth.AuthorizationScope = "https://{ACCOUNT}.blob.core.windows.net/user_impersonation"; blob.OAuth.ServerAuthURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize"; blob.OAuth.ServerTokenURL = "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token"; blob.Authorize();

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this GrantType the class expects a ClientId, ClientSecret, and ServerAuthURL to be set. When the Authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Password

Note: This grant type is considered insecure and should only be used when necessary.

When using the Resource Owner Password Credentials grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details.

For this GrantType the class requires OAuthPasswordGrantUsername, ClientSecret, and ServerTokenURL to be set. The ClientSecret should be set to the password of the account instead of a typical secret. In some cases, the ClientId also needs to be set. When the Authorize method is called, the component will make a request to the token server for an access token using the username and password. The token server will return an access token if the authentication was successful. When this access token is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one.

Web Profile

External OAuth Support

Bearer ACCESS_TOKEN_VALUE

Assign this value to the Authorization property before attempting any operations. Setting the Authorization property will cause the class to ignore the values set in the OAuth property.

Consult the Azure Blob Storage service's documentation for more information about using OAuth authentication.

Usage

Once authenticated, you can start interacting with the Azure Blob Storage service. The following list shows some of the methods used to accomplish common tasks:

• Container management: ListContainers, GetContainerInfo, CreateContainer, DeleteContainer, GetContainerACL, SetContainerACL
• Blob management: ListBlobs, GetBlobInfo, UpdateBlobInfo, CreateBlob, CopyBlob, GetBlob, DeleteBlob, UndeleteBlob
• Block blob management: ListBlocks, PutBlock, PutBlockList
• Page blob management: ListPageRanges, PutPages, ClearPages, UpdatePageBlob
• Append blob management: AppendBlock

The class support much more than just the functionality described above; refer to the complete API, below, for more information.

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

The Azure 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_azureblob_getaccesskey(void* lpObj);
int cloudstorage_azureblob_setaccesskey(void* lpObj, const char* lpszAccessKey);

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

Default Value

""

Remarks

This property specifies the Azure access key that should be used for authentication. It must be set before attempting any operations which connect to the server.

Both primary and secondary access keys are valid.

Note: this property's value is ignored if the Authorization property is populated.

This property is not available at design time.

Data Type

String

AccessPolicies Property (AzureBlob Class)

A collection of access policies.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageAzureAccessPolicy>* GetAccessPolicies();
int SetAccessPolicies(CloudStorageList<CloudStorageAzureAccessPolicy>* val);

int cloudstorage_azureblob_getaccesspolicycount(void* lpObj);
int cloudstorage_azureblob_setaccesspolicycount(void* lpObj, int iAccessPolicyCount);

char* cloudstorage_azureblob_getaccesspolicyexpirytime(void* lpObj, int accesspolicyindex);
int cloudstorage_azureblob_setaccesspolicyexpirytime(void* lpObj, int accesspolicyindex, const char* lpszAccessPolicyExpiryTime);

char* cloudstorage_azureblob_getaccesspolicyid(void* lpObj, int accesspolicyindex);
int cloudstorage_azureblob_setaccesspolicyid(void* lpObj, int accesspolicyindex, const char* lpszAccessPolicyId);

char* cloudstorage_azureblob_getaccesspolicypermissions(void* lpObj, int accesspolicyindex);
int cloudstorage_azureblob_setaccesspolicypermissions(void* lpObj, int accesspolicyindex, const char* lpszAccessPolicyPermissions);

char* cloudstorage_azureblob_getaccesspolicystarttime(void* lpObj, int accesspolicyindex);
int cloudstorage_azureblob_setaccesspolicystarttime(void* lpObj, int accesspolicyindex, const char* lpszAccessPolicyStartTime);

int GetAccessPolicyCount();
int SetAccessPolicyCount(int iAccessPolicyCount);

QString GetAccessPolicyExpiryTime(int iAccessPolicyIndex);
int SetAccessPolicyExpiryTime(int iAccessPolicyIndex, QString qsAccessPolicyExpiryTime);

QString GetAccessPolicyId(int iAccessPolicyIndex);
int SetAccessPolicyId(int iAccessPolicyIndex, QString qsAccessPolicyId);

QString GetAccessPolicyPermissions(int iAccessPolicyIndex);
int SetAccessPolicyPermissions(int iAccessPolicyIndex, QString qsAccessPolicyPermissions);

QString GetAccessPolicyStartTime(int iAccessPolicyIndex);
int SetAccessPolicyStartTime(int iAccessPolicyIndex, QString qsAccessPolicyStartTime);

Remarks

This collection holds a list of AzureAccessPolicy items.

This collection is populated anytime GetContainerACL is called; and its items are used anytime SetContainerACL is called.

This property is not available at design time.

Data Type

CloudStorageAzureAccessPolicy

Account Property (AzureBlob Class)

The Azure storage account name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAccount();
int SetAccount(const char* lpszAccount);

Unicode (Windows)
LPWSTR GetAccount();
INT SetAccount(LPCWSTR lpszAccount);

char* cloudstorage_azureblob_getaccount(void* lpObj);
int cloudstorage_azureblob_setaccount(void* lpObj, const char* lpszAccount);

QString GetAccount();
int SetAccount(QString qsAccount);

Default Value

""

Remarks

This property specifies the name of the Azure storage account to operate against. It must be set before attempting any operations which connect to the server.

This property is not available at design time.

Data Type

String

Authorization Property (AzureBlob Class)

OAuth 2.0 Authorization Token.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization);

Unicode (Windows)
LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);

char* cloudstorage_azureblob_getauthorization(void* lpObj);
int cloudstorage_azureblob_setauthorization(void* lpObj, const char* lpszAuthorization);

QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth class or a separate process. If using the OAuth property, then the Authorization property will not be used.

Bearer ACCESS_TOKEN

Note: if both this property and AccessKey are populated, this property takes precedence, and the class will use OAuth authentication instead of shared key authentication. The Account property must be set in either case.

Data Type

String

BlobData Property (AzureBlob Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlobData(char* &lpBlobData, int &lenBlobData);
int SetBlobData(const char* lpBlobData, int lenBlobData);

Unicode (Windows)
INT GetBlobData(LPSTR &lpBlobData, INT &lenBlobData);
INT SetBlobData(LPCSTR lpBlobData, INT lenBlobData);

int cloudstorage_azureblob_getblobdata(void* lpObj, char** lpBlobData, int* lenBlobData);
int cloudstorage_azureblob_setblobdata(void* lpObj, const char* lpBlobData, int lenBlobData);

QByteArray GetBlobData();
int SetBlobData(QByteArray qbaBlobData);

Default Value

""

Remarks

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

This property can also be set before calling AppendBlock, CreateBlob (for block blobs), PutBlock, or PutPages; its data will be uploaded if SetUploadStream and LocalFile are not set.

This property is not available at design time.

Data Type

Binary String

BlobDelimiter Property (AzureBlob Class)

The delimiter string to use when listing blobs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBlobDelimiter();
int SetBlobDelimiter(const char* lpszBlobDelimiter);

Unicode (Windows)
LPWSTR GetBlobDelimiter();
INT SetBlobDelimiter(LPCWSTR lpszBlobDelimiter);

char* cloudstorage_azureblob_getblobdelimiter(void* lpObj);
int cloudstorage_azureblob_setblobdelimiter(void* lpObj, const char* lpszBlobDelimiter);

QString GetBlobDelimiter();
int SetBlobDelimiter(QString qsBlobDelimiter);

Default Value

""

Remarks

If this property is non-empty when ListBlobs is called, any blobs whose names contain the same string between the specified Prefix 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 blobs 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

Blob Namespace Traversal

By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

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

With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:

This property is not available at design time.

Data Type

String

BlobMarker Property (AzureBlob Class)

A marker indicating what page of blobs to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBlobMarker();
int SetBlobMarker(const char* lpszBlobMarker);

Unicode (Windows)
LPWSTR GetBlobMarker();
INT SetBlobMarker(LPCWSTR lpszBlobMarker);

char* cloudstorage_azureblob_getblobmarker(void* lpObj);
int cloudstorage_azureblob_setblobmarker(void* lpObj, const char* lpszBlobMarker);

QString GetBlobMarker();
int SetBlobMarker(QString qsBlobMarker);

Default Value

""

Remarks

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

Refer to ListBlobs for more information.

This property is not available at design time.

Data Type

String

Blobs Property (AzureBlob Class)

A collection of blobs.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageAzureBlobBlob>* GetBlobs();
int SetBlobs(CloudStorageList<CloudStorageAzureBlobBlob>* val);

int cloudstorage_azureblob_getblobcount(void* lpObj);
int cloudstorage_azureblob_setblobcount(void* lpObj, int iBlobCount);

char* cloudstorage_azureblob_getblobcontainer(void* lpObj, int blobindex);

char* cloudstorage_azureblob_getblobcontentdisposition(void* lpObj, int blobindex);
int cloudstorage_azureblob_setblobcontentdisposition(void* lpObj, int blobindex, const char* lpszBlobContentDisposition);

char* cloudstorage_azureblob_getblobcontentencoding(void* lpObj, int blobindex);
int cloudstorage_azureblob_setblobcontentencoding(void* lpObj, int blobindex, const char* lpszBlobContentEncoding);

int64 cloudstorage_azureblob_getblobcontentlength(void* lpObj, int blobindex);

char* cloudstorage_azureblob_getblobcontentmd5(void* lpObj, int blobindex);
int cloudstorage_azureblob_setblobcontentmd5(void* lpObj, int blobindex, const char* lpszBlobContentMD5);

char* cloudstorage_azureblob_getblobcontenttype(void* lpObj, int blobindex);
int cloudstorage_azureblob_setblobcontenttype(void* lpObj, int blobindex, const char* lpszBlobContentType);

char* cloudstorage_azureblob_getblobcreatedtime(void* lpObj, int blobindex);

char* cloudstorage_azureblob_getblobetag(void* lpObj, int blobindex);

int cloudstorage_azureblob_getblobisleased(void* lpObj, int blobindex);

int cloudstorage_azureblob_getblobisleaseinfinite(void* lpObj, int blobindex);

int cloudstorage_azureblob_getblobleasestate(void* lpObj, int blobindex);

char* cloudstorage_azureblob_getblobmodifiedtime(void* lpObj, int blobindex);

char* cloudstorage_azureblob_getblobname(void* lpObj, int blobindex);
int cloudstorage_azureblob_setblobname(void* lpObj, int blobindex, const char* lpszBlobName);

int64 cloudstorage_azureblob_getblobsequencenum(void* lpObj, int blobindex);

char* cloudstorage_azureblob_getblobsnapshot(void* lpObj, int blobindex);

int cloudstorage_azureblob_getblobsoftdeleted(void* lpObj, int blobindex);

int cloudstorage_azureblob_getblobtype(void* lpObj, int blobindex);

int GetBlobCount();
int SetBlobCount(int iBlobCount);

QString GetBlobContainer(int iBlobIndex);

QString GetBlobContentDisposition(int iBlobIndex);
int SetBlobContentDisposition(int iBlobIndex, QString qsBlobContentDisposition);

QString GetBlobContentEncoding(int iBlobIndex);
int SetBlobContentEncoding(int iBlobIndex, QString qsBlobContentEncoding);

qint64 GetBlobContentLength(int iBlobIndex);

QString GetBlobContentMD5(int iBlobIndex);
int SetBlobContentMD5(int iBlobIndex, QString qsBlobContentMD5);

QString GetBlobContentType(int iBlobIndex);
int SetBlobContentType(int iBlobIndex, QString qsBlobContentType);

QString GetBlobCreatedTime(int iBlobIndex);

QString GetBlobETag(int iBlobIndex);

bool GetBlobIsLeased(int iBlobIndex);

bool GetBlobIsLeaseInfinite(int iBlobIndex);

int GetBlobLeaseState(int iBlobIndex);

QString GetBlobModifiedTime(int iBlobIndex);

QString GetBlobName(int iBlobIndex);
int SetBlobName(int iBlobIndex, QString qsBlobName);

qint64 GetBlobSequenceNum(int iBlobIndex);

QString GetBlobSnapshot(int iBlobIndex);

bool GetBlobSoftDeleted(int iBlobIndex);

int GetBlobType(int iBlobIndex);

Remarks

This collection holds a list of AzureBlobBlob items.

Calling ListBlobs or GetBlobInfo will populate this collection.

This property is not available at design time.

Data Type

CloudStorageAzureBlobBlob

Blocks Property (AzureBlob Class)

A collection of blocks.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageAzureBlobBlock>* GetBlocks();
int SetBlocks(CloudStorageList<CloudStorageAzureBlobBlock>* val);

int cloudstorage_azureblob_getblockcount(void* lpObj);
int cloudstorage_azureblob_setblockcount(void* lpObj, int iBlockCount);

char* cloudstorage_azureblob_getblockid(void* lpObj, int blockindex);
int cloudstorage_azureblob_setblockid(void* lpObj, int blockindex, const char* lpszBlockId);

int cloudstorage_azureblob_getblocksize(void* lpObj, int blockindex);

int cloudstorage_azureblob_getblocktype(void* lpObj, int blockindex);
int cloudstorage_azureblob_setblocktype(void* lpObj, int blockindex, int iBlockType);

int GetBlockCount();
int SetBlockCount(int iBlockCount);

QString GetBlockId(int iBlockIndex);
int SetBlockId(int iBlockIndex, QString qsBlockId);

int GetBlockSize(int iBlockIndex);

int GetBlockType(int iBlockIndex);
int SetBlockType(int iBlockIndex, int iBlockType);

Remarks

This collection holds a list of AzureBlobBlock items.

Calling ListBlocks or AddBlock will populate this collection; and its items are used anytime PutBlockList is called. Additionally, if the CreateBlob method is used to create a new block blob, and more than 256MB if upload data is provided, the class will use this collection as it automatically uploads the data; refer to CreateBlob for more information.

This property is not available at design time.

Data Type

CloudStorageAzureBlobBlock

Container Property (AzureBlob Class)

Selects a container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContainer();
int SetContainer(const char* lpszContainer);

Unicode (Windows)
LPWSTR GetContainer();
INT SetContainer(LPCWSTR lpszContainer);

char* cloudstorage_azureblob_getcontainer(void* lpObj);
int cloudstorage_azureblob_setcontainer(void* lpObj, const char* lpszContainer);

QString GetContainer();
int SetContainer(QString qsContainer);

Default Value

""

Remarks

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

Container Name Rules

Container names must adhere to the following rules:

• Must be 3 to 63 characters long.
• Must start with a letter or number; and may only contain letters, numbers, and hyphens.
• All letters much be lowercase. (For convenience, the class will automatically lowercase all letters in any value assigned to Container.)
• All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).

This property is not available at design time.

Data Type

String

ContainerMarker Property (AzureBlob Class)

A marker indicating what page of containers to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContainerMarker();
int SetContainerMarker(const char* lpszContainerMarker);

Unicode (Windows)
LPWSTR GetContainerMarker();
INT SetContainerMarker(LPCWSTR lpszContainerMarker);

char* cloudstorage_azureblob_getcontainermarker(void* lpObj);
int cloudstorage_azureblob_setcontainermarker(void* lpObj, const char* lpszContainerMarker);

QString GetContainerMarker();
int SetContainerMarker(QString qsContainerMarker);

Default Value

""

Remarks

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

Refer to ListContainers for more information.

This property is not available at design time.

Data Type

String

Containers Property (AzureBlob Class)

A collection of containers.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageAzureBlobContainer>* GetContainers();

int cloudstorage_azureblob_getcontainercount(void* lpObj);

char* cloudstorage_azureblob_getcontainerdeletedversion(void* lpObj, int containerindex);

char* cloudstorage_azureblob_getcontaineretag(void* lpObj, int containerindex);

int cloudstorage_azureblob_getcontainerhasimmutabilitypolicy(void* lpObj, int containerindex);

int cloudstorage_azureblob_getcontainerhaslegalhold(void* lpObj, int containerindex);

int cloudstorage_azureblob_getcontainerisleased(void* lpObj, int containerindex);

int cloudstorage_azureblob_getcontainerisleaseinfinite(void* lpObj, int containerindex);

int cloudstorage_azureblob_getcontainerleasestate(void* lpObj, int containerindex);

char* cloudstorage_azureblob_getcontainermodifiedtime(void* lpObj, int containerindex);

char* cloudstorage_azureblob_getcontainername(void* lpObj, int containerindex);

int cloudstorage_azureblob_getcontainerpublicaccess(void* lpObj, int containerindex);

int cloudstorage_azureblob_getcontainersoftdeleted(void* lpObj, int containerindex);

int GetContainerCount();

QString GetContainerDeletedVersion(int iContainerIndex);

QString GetContainerETag(int iContainerIndex);

bool GetContainerHasImmutabilityPolicy(int iContainerIndex);

bool GetContainerHasLegalHold(int iContainerIndex);

bool GetContainerIsLeased(int iContainerIndex);

bool GetContainerIsLeaseInfinite(int iContainerIndex);

int GetContainerLeaseState(int iContainerIndex);

QString GetContainerModifiedTime(int iContainerIndex);

QString GetContainerName(int iContainerIndex);

int GetContainerPublicAccess(int iContainerIndex);

bool GetContainerSoftDeleted(int iContainerIndex);

Remarks

This collection holds a list of AzureBlobContainer items.

Calling ListContainers or GetContainerInfo will populate this collection.

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

Data Type

CloudStorageAzureBlobContainer

EncryptionAlgorithm Property (AzureBlob 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_azureblob_getencryptionalgorithm(void* lpObj);
int cloudstorage_azureblob_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 (AzureBlob 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_azureblob_getencryptionpassword(void* lpObj);
int cloudstorage_azureblob_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

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

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

Firewall Property (AzureBlob Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

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

int cloudstorage_azureblob_getfirewallautodetect(void* lpObj);
int cloudstorage_azureblob_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int cloudstorage_azureblob_getfirewalltype(void* lpObj);
int cloudstorage_azureblob_setfirewalltype(void* lpObj, int iFirewallType);

char* cloudstorage_azureblob_getfirewallhost(void* lpObj);
int cloudstorage_azureblob_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* cloudstorage_azureblob_getfirewallpassword(void* lpObj);
int cloudstorage_azureblob_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int cloudstorage_azureblob_getfirewallport(void* lpObj);
int cloudstorage_azureblob_setfirewallport(void* lpObj, int iFirewallPort);

char* cloudstorage_azureblob_getfirewalluser(void* lpObj);
int cloudstorage_azureblob_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

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

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

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

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

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

Remarks

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

Data Type

CloudStorageFirewall

Idle Property (AzureBlob Class)

This property specifies the current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_azureblob_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LeaseId Property (AzureBlob Class)

The lease Id to include when making requests.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLeaseId();
int SetLeaseId(const char* lpszLeaseId);

Unicode (Windows)
LPWSTR GetLeaseId();
INT SetLeaseId(LPCWSTR lpszLeaseId);

char* cloudstorage_azureblob_getleaseid(void* lpObj);
int cloudstorage_azureblob_setleaseid(void* lpObj, const char* lpszLeaseId);

QString GetLeaseId();
int SetLeaseId(QString qsLeaseId);

Default Value

""

Remarks

This property specifies the lease Id to include when making requests. If non-empty, this property's value must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.

The following table indicates whether this property should be populated when calling a method on a container or blob that has an active lease.

For methods in one of the "MUST" categories: if this property is empty, requests will fail if the container or blob has an active lease. For CreateBlob and CopyBlob, note that this property must be empty if the target blob does not yet exist.

For all methods listed above: if this property is populated, requests will fail if the container or blob doesn't have an active lease; or if it does, but the lease Id specified by this property does not match.

Finally, note that this property is used in a specific manner by the Lease method; refer to its documentation for more information.

This property is not available at design time.

Data Type

String

LocalFile Property (AzureBlob 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_azureblob_getlocalfile(void* lpObj);
wchar_t* cloudstorage_azureblob_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_azureblob_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_azureblob_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 AppendBlock, CreateBlob (for block blobs), PutBlock, or PutPages; and as the destination file when calling GetBlob.

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

This property includes 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_azureblob_getlocalhost(void* lpObj);
int cloudstorage_azureblob_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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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

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

Data Type

String

Metadata Property (AzureBlob Class)

A collection of metadata items.

Syntax

• C++
• C
• Qt

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

int cloudstorage_azureblob_getmetadatacount(void* lpObj);
int cloudstorage_azureblob_setmetadatacount(void* lpObj, int iMetadataCount);

char* cloudstorage_azureblob_getmetadataname(void* lpObj, int metadataindex);
int cloudstorage_azureblob_setmetadataname(void* lpObj, int metadataindex, const char* lpszMetadataName);

char* cloudstorage_azureblob_getmetadatavalue(void* lpObj, int metadataindex);
int cloudstorage_azureblob_setmetadatavalue(void* lpObj, int metadataindex, const char* lpszMetadataValue);

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

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

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

Remarks

This collection holds a list of AzureMetadata items.

This collection is populated when GetBlobInfo or GetContainerInfo is called; and its items are used anytime UpdateMetadata is called. Additionally, its items may be used when CreateBlob, CreateSnapshot, CopyBlob, and/or PutBlockList are called, depending on how the various SendMetadata* configuration settings are set.

This property is not available at design time.

Data Type

CloudStorageAzureMetadata

OAuth Property (AzureBlob Class)

This property holds the OAuth Settings.

Syntax

• C++
• C
• Qt

CloudStorageOAuthSettings* GetOAuth();

char* cloudstorage_azureblob_getoauthaccesstoken(void* lpObj);
int cloudstorage_azureblob_setoauthaccesstoken(void* lpObj, const char* lpszOAuthAccessToken);

char* cloudstorage_azureblob_getoauthauthorizationcode(void* lpObj);
int cloudstorage_azureblob_setoauthauthorizationcode(void* lpObj, const char* lpszOAuthAuthorizationCode);

char* cloudstorage_azureblob_getoauthauthorizationscope(void* lpObj);
int cloudstorage_azureblob_setoauthauthorizationscope(void* lpObj, const char* lpszOAuthAuthorizationScope);

char* cloudstorage_azureblob_getoauthclientid(void* lpObj);
int cloudstorage_azureblob_setoauthclientid(void* lpObj, const char* lpszOAuthClientId);

int cloudstorage_azureblob_getoauthclientprofile(void* lpObj);
int cloudstorage_azureblob_setoauthclientprofile(void* lpObj, int iOAuthClientProfile);

char* cloudstorage_azureblob_getoauthclientsecret(void* lpObj);
int cloudstorage_azureblob_setoauthclientsecret(void* lpObj, const char* lpszOAuthClientSecret);

int cloudstorage_azureblob_getoauthgranttype(void* lpObj);
int cloudstorage_azureblob_setoauthgranttype(void* lpObj, int iOAuthGrantType);

char* cloudstorage_azureblob_getoauthrefreshtoken(void* lpObj);
int cloudstorage_azureblob_setoauthrefreshtoken(void* lpObj, const char* lpszOAuthRefreshToken);

int cloudstorage_azureblob_getoauthrequestrefreshtoken(void* lpObj);
int cloudstorage_azureblob_setoauthrequestrefreshtoken(void* lpObj, int bOAuthRequestRefreshToken);

char* cloudstorage_azureblob_getoauthreturnurl(void* lpObj);
int cloudstorage_azureblob_setoauthreturnurl(void* lpObj, const char* lpszOAuthReturnURL);

char* cloudstorage_azureblob_getoauthserverauthurl(void* lpObj);
int cloudstorage_azureblob_setoauthserverauthurl(void* lpObj, const char* lpszOAuthServerAuthURL);

char* cloudstorage_azureblob_getoauthservertokenurl(void* lpObj);
int cloudstorage_azureblob_setoauthservertokenurl(void* lpObj, const char* lpszOAuthServerTokenURL);

char* cloudstorage_azureblob_getoauthwebauthurl(void* lpObj);

QString GetOAuthAccessToken();
int SetOAuthAccessToken(QString qsOAuthAccessToken);

QString GetOAuthAuthorizationCode();
int SetOAuthAuthorizationCode(QString qsOAuthAuthorizationCode);

QString GetOAuthAuthorizationScope();
int SetOAuthAuthorizationScope(QString qsOAuthAuthorizationScope);

QString GetOAuthClientId();
int SetOAuthClientId(QString qsOAuthClientId);

int GetOAuthClientProfile();
int SetOAuthClientProfile(int iOAuthClientProfile);

QString GetOAuthClientSecret();
int SetOAuthClientSecret(QString qsOAuthClientSecret);

int GetOAuthGrantType();
int SetOAuthGrantType(int iOAuthGrantType);

QString GetOAuthRefreshToken();
int SetOAuthRefreshToken(QString qsOAuthRefreshToken);

bool GetOAuthRequestRefreshToken();
int SetOAuthRequestRefreshToken(bool bOAuthRequestRefreshToken);

QString GetOAuthReturnURL();
int SetOAuthReturnURL(QString qsOAuthReturnURL);

QString GetOAuthServerAuthURL();
int SetOAuthServerAuthURL(QString qsOAuthServerAuthURL);

QString GetOAuthServerTokenURL();
int SetOAuthServerTokenURL(QString qsOAuthServerTokenURL);

QString GetOAuthWebAuthURL();

Remarks

This property is used to define the necessary fields to authenticate with the service provider. See the introduction for more information.

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

Data Type

CloudStorageOAuthSettings

OtherHeaders Property (AzureBlob 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_azureblob_getotherheaders(void* lpObj);
int cloudstorage_azureblob_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 (AzureBlob Class)

Whether to overwrite the local file, or remote blob.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azureblob_getoverwrite(void* lpObj);
int cloudstorage_azureblob_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

When calling DownloadFile, this property determines if LocalFile should be overwritten if it already exists.

When calling CreateBlob or CopyBlob, this property determines if the remote blob should be overwritten if it already exists.

Data Type

Boolean

PageRanges Property (AzureBlob Class)

A collection of page range items.

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageAzureRange>* GetPageRanges();

int cloudstorage_azureblob_getpagerangecount(void* lpObj);

int64 cloudstorage_azureblob_getpagerangefirst(void* lpObj, int pagerangeindex);

int64 cloudstorage_azureblob_getpagerangelast(void* lpObj, int pagerangeindex);

int GetPageRangeCount();

qint64 GetPageRangeFirst(int iPageRangeIndex);

qint64 GetPageRangeLast(int iPageRangeIndex);

Remarks

This collection holds a list of AzureRange items.

This collection is populated when ListPageRanges is called.

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

Data Type

CloudStorageAzureRange

ParsedHeaders Property (AzureBlob Class)

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

Syntax

• C++
• C
• Qt

CloudStorageList<CloudStorageHeader>* GetParsedHeaders();

int cloudstorage_azureblob_getparsedheadercount(void* lpObj);

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

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

int GetParsedHeaderCount();

QString GetParsedHeaderField(int iParsedHeaderIndex);

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Remarks

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

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

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

Data Type

CloudStorageHeader

Prefix Property (AzureBlob Class)

A prefix used to restrict the results returned when listing blobs or containers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPrefix();
int SetPrefix(const char* lpszPrefix);

Unicode (Windows)
LPWSTR GetPrefix();
INT SetPrefix(LPCWSTR lpszPrefix);

char* cloudstorage_azureblob_getprefix(void* lpObj);
int cloudstorage_azureblob_setprefix(void* lpObj, const char* lpszPrefix);

QString GetPrefix();
int SetPrefix(QString qsPrefix);

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by ListBlobs or ListContainers to only the items whose names begin with the given value.

Blob Namespace Traversal

By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

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

With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:

This property is not available at design time.

Data Type

String

Proxy Property (AzureBlob Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

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

int cloudstorage_azureblob_getproxyauthscheme(void* lpObj);
int cloudstorage_azureblob_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int cloudstorage_azureblob_getproxyautodetect(void* lpObj);
int cloudstorage_azureblob_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

char* cloudstorage_azureblob_getproxypassword(void* lpObj);
int cloudstorage_azureblob_setproxypassword(void* lpObj, const char* lpszProxyPassword);

int cloudstorage_azureblob_getproxyport(void* lpObj);
int cloudstorage_azureblob_setproxyport(void* lpObj, int iProxyPort);

char* cloudstorage_azureblob_getproxyserver(void* lpObj);
int cloudstorage_azureblob_setproxyserver(void* lpObj, const char* lpszProxyServer);

int cloudstorage_azureblob_getproxyssl(void* lpObj);
int cloudstorage_azureblob_setproxyssl(void* lpObj, int iProxySSL);

char* cloudstorage_azureblob_getproxyuser(void* lpObj);
int cloudstorage_azureblob_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

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

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

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

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

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

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

Remarks

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

Data Type

CloudStorageProxy

QueryParams Property (AzureBlob Class)

Additional query parameters to be included in the request.

Syntax

• C++
• C
• Qt

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

int cloudstorage_azureblob_getqueryparamcount(void* lpObj);
int cloudstorage_azureblob_setqueryparamcount(void* lpObj, int iQueryParamCount);

char* cloudstorage_azureblob_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_azureblob_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

char* cloudstorage_azureblob_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_azureblob_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

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

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

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

Remarks

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

Data Type

CloudStorageQueryParam

Range Property (AzureBlob 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_azureblob_getrange(void* lpObj);
int cloudstorage_azureblob_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 GetBlob or ListPageRanges request is being constructed, a header like x-ms-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 GetBlob 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 x-ms-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

Snapshot Property (AzureBlob Class)

The blob snapshot to make requests against.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSnapshot();
int SetSnapshot(const char* lpszSnapshot);

Unicode (Windows)
LPWSTR GetSnapshot();
INT SetSnapshot(LPCWSTR lpszSnapshot);

char* cloudstorage_azureblob_getsnapshot(void* lpObj);
int cloudstorage_azureblob_setsnapshot(void* lpObj, const char* lpszSnapshot);

QString GetSnapshot();
int SetSnapshot(QString qsSnapshot);

Default Value

""

Remarks

This property can be set to the opaque DateTime value used to identify a particular blob snapshot before calling the following methods in order to make requests against the specified blob snapshot instead of the base blob:

• CopyBlob (to copy from a blob snapshot)
• DeleteBlob
• GetBlob
• GetBlobInfo
• GetLink (to build a link for a specific blob snapshot)
• ListPageRanges
• SendCustomRequest

Refer to the documentation of the methods listed above for more information.

This property is not available at design time.

Data Type

String

SSLAcceptServerCert Property (AzureBlob Class)

This property instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

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

char* cloudstorage_azureblob_getsslacceptservercerteffectivedate(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertexpirationdate(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertextendedkeyusage(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertfingerprint(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertfingerprintsha1(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertfingerprintsha256(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertissuer(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertprivatekey(void* lpObj);

int cloudstorage_azureblob_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertpublickey(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_azureblob_getsslacceptservercertpublickeylength(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertserialnumber(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertsignaturealgorithm(void* lpObj);

int cloudstorage_azureblob_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int cloudstorage_azureblob_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* cloudstorage_azureblob_getsslacceptservercertstorepassword(void* lpObj);
int cloudstorage_azureblob_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int cloudstorage_azureblob_getsslacceptservercertstoretype(void* lpObj);
int cloudstorage_azureblob_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* cloudstorage_azureblob_getsslacceptservercertsubjectaltnames(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertthumbprintmd5(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertthumbprintsha1(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertthumbprintsha256(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertusage(void* lpObj);

int cloudstorage_azureblob_getsslacceptservercertusageflags(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertversion(void* lpObj);

char* cloudstorage_azureblob_getsslacceptservercertsubject(void* lpObj);
int cloudstorage_azureblob_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

int cloudstorage_azureblob_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_azureblob_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

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

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

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

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

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

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

Remarks

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

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

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

Data Type

CloudStorageCertificate

SSLCert Property (AzureBlob Class)

This property includes the certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

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

char* cloudstorage_azureblob_getsslcerteffectivedate(void* lpObj);

char* cloudstorage_azureblob_getsslcertexpirationdate(void* lpObj);

char* cloudstorage_azureblob_getsslcertextendedkeyusage(void* lpObj);

char* cloudstorage_azureblob_getsslcertfingerprint(void* lpObj);

char* cloudstorage_azureblob_getsslcertfingerprintsha1(void* lpObj);

char* cloudstorage_azureblob_getsslcertfingerprintsha256(void* lpObj);

char* cloudstorage_azureblob_getsslcertissuer(void* lpObj);

char* cloudstorage_azureblob_getsslcertprivatekey(void* lpObj);

int cloudstorage_azureblob_getsslcertprivatekeyavailable(void* lpObj);

char* cloudstorage_azureblob_getsslcertprivatekeycontainer(void* lpObj);

char* cloudstorage_azureblob_getsslcertpublickey(void* lpObj);

char* cloudstorage_azureblob_getsslcertpublickeyalgorithm(void* lpObj);

int cloudstorage_azureblob_getsslcertpublickeylength(void* lpObj);

char* cloudstorage_azureblob_getsslcertserialnumber(void* lpObj);

char* cloudstorage_azureblob_getsslcertsignaturealgorithm(void* lpObj);

int cloudstorage_azureblob_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_azureblob_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* cloudstorage_azureblob_getsslcertstorepassword(void* lpObj);
int cloudstorage_azureblob_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int cloudstorage_azureblob_getsslcertstoretype(void* lpObj);
int cloudstorage_azureblob_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* cloudstorage_azureblob_getsslcertsubjectaltnames(void* lpObj);

char* cloudstorage_azureblob_getsslcertthumbprintmd5(void* lpObj);

char* cloudstorage_azureblob_getsslcertthumbprintsha1(void* lpObj);

char* cloudstorage_azureblob_getsslcertthumbprintsha256(void* lpObj);

char* cloudstorage_azureblob_getsslcertusage(void* lpObj);

int cloudstorage_azureblob_getsslcertusageflags(void* lpObj);

char* cloudstorage_azureblob_getsslcertversion(void* lpObj);

char* cloudstorage_azureblob_getsslcertsubject(void* lpObj);
int cloudstorage_azureblob_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int cloudstorage_azureblob_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_azureblob_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

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

Data Type

CloudStorageCertificate

SSLProvider Property (AzureBlob Class)

This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_azureblob_getsslprovider(void* lpObj);
int cloudstorage_azureblob_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are as follows:

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

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

Data Type

Integer

SSLServerCert Property (AzureBlob Class)

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

Syntax

• C++
• C
• Qt

CloudStorageCertificate* GetSSLServerCert();

char* cloudstorage_azureblob_getsslservercerteffectivedate(void* lpObj);

char* cloudstorage_azureblob_getsslservercertexpirationdate(void* lpObj);

char* cloudstorage_azureblob_getsslservercertextendedkeyusage(void* lpObj);

char* cloudstorage_azureblob_getsslservercertfingerprint(void* lpObj);

char* cloudstorage_azureblob_getsslservercertfingerprintsha1(void* lpObj);

char* cloudstorage_azureblob_getsslservercertfingerprintsha256(void* lpObj);

char* cloudstorage_azureblob_getsslservercertissuer(void* lpObj);

char* cloudstorage_azureblob_getsslservercertprivatekey(void* lpObj);

int cloudstorage_azureblob_getsslservercertprivatekeyavailable(void* lpObj);

char* cloudstorage_azureblob_getsslservercertprivatekeycontainer(void* lpObj);

char* cloudstorage_azureblob_getsslservercertpublickey(void* lpObj);

char* cloudstorage_azureblob_getsslservercertpublickeyalgorithm(void* lpObj);

int cloudstorage_azureblob_getsslservercertpublickeylength(void* lpObj);

char* cloudstorage_azureblob_getsslservercertserialnumber(void* lpObj);

char* cloudstorage_azureblob_getsslservercertsignaturealgorithm(void* lpObj);

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

char* cloudstorage_azureblob_getsslservercertstorepassword(void* lpObj);

int cloudstorage_azureblob_getsslservercertstoretype(void* lpObj);

char* cloudstorage_azureblob_getsslservercertsubjectaltnames(void* lpObj);

char* cloudstorage_azureblob_getsslservercertthumbprintmd5(void* lpObj);

char* cloudstorage_azureblob_getsslservercertthumbprintsha1(void* lpObj);

char* cloudstorage_azureblob_getsslservercertthumbprintsha256(void* lpObj);

char* cloudstorage_azureblob_getsslservercertusage(void* lpObj);

int cloudstorage_azureblob_getsslservercertusageflags(void* lpObj);

char* cloudstorage_azureblob_getsslservercertversion(void* lpObj);

char* cloudstorage_azureblob_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

CloudStorageCertificate

StartByte Property (AzureBlob 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_azureblob_getstartbyte(void* lpObj);
int cloudstorage_azureblob_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 a block blob upload using CreateBlob, or a download of any blob type using GetBlob. 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 CreateBlob is called. Keep this in mind when resuming interrupted block blob uploads.

This property is not available at design time.

Data Type

Long64

Timeout Property (AzureBlob Class)

This property includes the timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azureblob_gettimeout(void* lpObj);
int cloudstorage_azureblob_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseSSL Property (AzureBlob Class)

Whether to use SSL/TLS when connecting.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azureblob_getusessl(void* lpObj);
int cloudstorage_azureblob_setusessl(void* lpObj, int bUseSSL);

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

Default Value

TRUE

Remarks

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

This property is not available at design time.

Data Type

Boolean

AbortCopy Method (AzureBlob Class)

Aborts a copy operation.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AbortCopy(const char* lpszDestBlob, const char* lpszCopyId);

Unicode (Windows)
INT AbortCopy(LPCWSTR lpszDestBlob, LPCWSTR lpszCopyId);

int cloudstorage_azureblob_abortcopy(void* lpObj, const char* lpszDestBlob, const char* lpszCopyId);

int AbortCopy(const QString& qsDestBlob, const QString& qsCopyId);

Remarks

This method aborts the copy operation identified by the given CopyId for the destination blob DestBlob in the container currently selected by Container.

Note that the destination blob will still exist after aborting a copy operation, but it will be empty.

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

AddBlock Method (AzureBlob Class)

Adds a block to the Blocks properties.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AddBlock(const char* lpszId, int iBlockListType);

Unicode (Windows)
INT AddBlock(LPCWSTR lpszId, INT iBlockListType);

int cloudstorage_azureblob_addblock(void* lpObj, const char* lpszId, int iBlockListType);

int AddBlock(const QString& qsId, int iBlockListType);

Remarks

This method adds a block to the Blocks properties. Id specifies the block's Id, and BlockListType specifies where the server should search for this block.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

Valid values for BlockListType are:

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 (AzureBlob 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_azureblob_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.

Note that the class will automatically prepend x-ms-meta- to metadata item names (as necessary) when they are submitted to the server. Also note that while metadata item names are case-preserving, they are not case-sensitive.

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 (AzureBlob 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_azureblob_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

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

Remarks

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

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

Error Handling (C++)

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

AppendBlock Method (AzureBlob Class)

Appends a block of data to an append blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int AppendBlock(const char* lpszAppendBlob);

Unicode (Windows)
INT AppendBlock(LPCWSTR lpszAppendBlob);

int cloudstorage_azureblob_appendblock(void* lpObj, const char* lpszAppendBlob);

int AppendBlock(const QString& qsAppendBlob);

Remarks

This method appends a block of data to the specified AppendBlob in the container currently selected by Container. The block of data is immediately available as part of the append blob, which must already exist.

Up to 100MB (104857600 bytes) of data may be appended in a single block, and up to 50000 blocks may be appended to a single append blob.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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

Authorize Method (AzureBlob Class)

Get the authorization string required to access the protected resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Authorize();

Unicode (Windows)
INT Authorize();

int cloudstorage_azureblob_authorize(void* lpObj);

int Authorize();

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the ClientProfile field and the GrantType field. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.

For more information, see the introduction section.

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

CalcAuthorization Method (AzureBlob Class)

Calculates the Authorization header based on provided credentials.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CalcAuthorization();

Unicode (Windows)
INT CalcAuthorization();

int cloudstorage_azureblob_calcauthorization(void* lpObj);

int CalcAuthorization();

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, User and Password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as Get or Post.

This method may be useful in cases where the Authorization value needs to be calculated prior to sending a request.

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

ClearPages Method (AzureBlob Class)

Clears a range of pages in a page blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ClearPages(const char* lpszPageBlob, int64 lByteOffset, int64 lPageCount);

Unicode (Windows)
INT ClearPages(LPCWSTR lpszPageBlob, LONG64 lByteOffset, LONG64 lPageCount);

int cloudstorage_azureblob_clearpages(void* lpObj, const char* lpszPageBlob, int64 lByteOffset, int64 lPageCount);

int ClearPages(const QString& qsPageBlob, qint64 lByteOffset, qint64 lPageCount);

Remarks

This method clears PageCount pages, from ByteOffset onwards, for the specified PageBlob in the container currently selected by Container.

ByteOffset must be a multiple of 512; i.e. ByteOffset % 512 == 0. PageCount must be a number between 1 and the number of pages in the page blob following ByteOffset (inclusive).

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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 (AzureBlob 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_azureblob_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.

CopyBlob Method (AzureBlob Class)

Copies a blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CopyBlob(const char* lpszSrcBlob, const char* lpszDestBlob, const char* lpszDestContainer);

Unicode (Windows)
LPWSTR CopyBlob(LPCWSTR lpszSrcBlob, LPCWSTR lpszDestBlob, LPCWSTR lpszDestContainer);

char* cloudstorage_azureblob_copyblob(void* lpObj, const char* lpszSrcBlob, const char* lpszDestBlob, const char* lpszDestContainer);

QString CopyBlob(const QString& qsSrcBlob, const QString& qsDestBlob, const QString& qsDestContainer);

Remarks

This method copies the specified SrcBlob (in the container currently selected by Container) to the specified DestBlob in DestContainer. If this method finishes successfully, it will either return an asynchronous copy Id, or an empty string (if the copy has finished already).

If Snapshot is non-empty, the specified snapshot of SrcBlob will be used as the copy source. In this case, DestBlob may be the same blob as SrcBlob to "promote" the snapshot, copying its contents back to the base blob.

If DestContainer is empty, the current value of Container is used instead. If DestContainer in non-empty, the value will automatically be lowercased when preparing the request.

If DestBlob already exists, and is the same type of blob as SrcBlob, then it will be overwritten if Overwrite is enabled. However, any snapshots associated with the existing blob are retained.

If DestBlob already exists and has an active infinite-duration lease, its lease Id must be specified using LeaseId, or the request will fail. (If it exists and has an active fixed-duration lease, the request will always fail.)

If the SendMetadataOnCopy configuration setting is enabled when this method is called, all items in the Metadata properties will be sent in the copy request and applied to DestBlob. Otherwise, the server will copy the metadata items from SrcBlob to DestBlob.

If the request succeeds, this method will always populate the CopyId and CopyStatus configuration settings (and clear CopyProgress and CopyStatusDesc).

Asynchronous Copy Notes

As mentioned, this method will return a copy operation Id if the copy operation was started asynchronously. In this case, use the GetBlobInfo method to poll the DestBlob blob's information, which will cause the CopyStatus, CopyStatusDesc, and CopyProgress configuration settings to be refreshed.

A copy operation whose CopyStatus is still pending may also be aborted by passing the copy operation Id returned by this method (or later retrieved from CopyId) to the AbortCopy method. // Copy a blob to another location within the same container. string copyResult = azureblob.CopyBlob("important.zip", "secrets.zip", ""); // If the returned value *isn't* empty string, then we'll monitor the status of the // asynchronous copy operation by polling once every 2 seconds using GetBlobInfo(). if (!string.IsNullOrEmpty(copyResult)) { do { azureblob.GetBlobInfo("secrets.zip"); Console.WriteLine("Copy progress: " + azureblob.Config("CopyProgress")); } while (azureblob.Config("CopyStatus") == "pending"); }

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.

CreateBlob Method (AzureBlob Class)

Creates a new blob of the specified type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateBlob(const char* lpszBlob, int iBlobType, int64 lPageBlobSize);

Unicode (Windows)
INT CreateBlob(LPCWSTR lpszBlob, INT iBlobType, LONG64 lPageBlobSize);

int cloudstorage_azureblob_createblob(void* lpObj, const char* lpszBlob, int iBlobType, int64 lPageBlobSize);

int CreateBlob(const QString& qsBlob, int iBlobType, qint64 lPageBlobSize);

Remarks

This method creates a new blob named Blob in the container currently selected by Container. BlobType specifies what type of blob should be created; valid values are: Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

PageBlobSize is only used when BlobType is abtPageBlob (1); it is ignored otherwise.

If the specified blob already exists, and is the same type of blob as BlobType specifies, then it will be overwritten if Overwrite is enabled. However, any snapshots associated with the existing blob are retained.

If the specified blob already exists and has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.

Creating Block Blobs

Block blobs can be created either with or without data initially. In either case, after the block blob is created, its contents can be managed by uploading blocks with PutBlock and then committing a new block list using PutBlockList.

If upload data is present when this method is called to create a block blob, it will be uploaded in one of two ways. If the amount of data provided is less than or equal to the limit specified by the SimpleUploadLimit configuration setting (268435456 bytes (256MB), by default), it will be uploaded directly in the create blob request.

If more than SimpleUploadLimit bytes of data are provided, the class will first create the new block blob, and then upload the data by splitting it up into blocks (sized according to the FragmentSize configuration setting), uploading them individually, and then committing a new block list. To accomplish this, the class automatically makes calls to PutBlock and PutBlockList internally, tracks the blocks as they are uploaded using the Blocks properties, and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each block is uploaded.

If, during a block-based upload, any individual PutBlock request (or the PutBlockList request) fails, the upload can be resumed be calling this method again with the same parameters, so long as the Blocks and StartByte properties still hold the same information as they did when the upload was interrupted.

When a block-based upload completes successfully, StartByte is reset to 0, but the Blocks properties remains populated. This allows applications to easily inspect the Ids of the uploaded blocks, which the class generates automatically in the following GUID format: dddddddd-dddd-dddd-dddd-dddddddddddd (where each d is a single hex digit).

Creating Page Blobs

Unlike block blobs, no data can be uploaded when creating a page blob. However, the page blob's size (i.e., capacity) must be specified using PageBlobSize. A page blob's size must be a 512-byte-aligned; i.e. PageBlobSize % 512 == 0.

Once a page blob has been created, its contents can be manipulated using the PutPages and ClearPages methods.

Creating Append Blobs

Append blobs must also be created without uploading any data initially. After a page blob has been created, data can be appended to it using the AppendBlock 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.)

CreateContainer Method (AzureBlob Class)

Creates a new container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateContainer();

Unicode (Windows)
INT CreateContainer();

int cloudstorage_azureblob_createcontainer(void* lpObj);

int CreateContainer();

Remarks

This method creates a new container using the name specified by the Container property;

If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.

Container Name Rules

Container names must adhere to the following rules:

• Must be 3 to 63 characters long.
• Must start with a letter or number; and may only contain letters, numbers, and hyphens.
• All letters much be lowercase. (For convenience, the class will automatically lowercase all letters in any value assigned to Container.)
• All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).

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

CreateSnapshot Method (AzureBlob Class)

Creates a new snapshot of a blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateSnapshot(const char* lpszBlob);

Unicode (Windows)
LPWSTR CreateSnapshot(LPCWSTR lpszBlob);

char* cloudstorage_azureblob_createsnapshot(void* lpObj, const char* lpszBlob);

QString CreateSnapshot(const QString& qsBlob);

Remarks

This method creates a new snapshot of the specified Blob in the container currently selected by Container, and returns the opaque DateTime value used to identify the newly-created snapshot.

If the SendMetadataOnSnapshot configuration setting is enabled when this method is called, all items in the Metadata properties will be sent in the request and applied to newly-created snapshot. Otherwise, the server will copy the metadata items from Blob to the snapshot.

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

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.

DeleteBlob Method (AzureBlob Class)

Deletes a blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteBlob(const char* lpszBlob, int iDeleteAction);

Unicode (Windows)
INT DeleteBlob(LPCWSTR lpszBlob, INT iDeleteAction);

int cloudstorage_azureblob_deleteblob(void* lpObj, const char* lpszBlob, int iDeleteAction);

int DeleteBlob(const QString& qsBlob, int iDeleteAction);

Remarks

This method deletes the specified Blob in the container currently selected by Container. DeleteAction specifies how the delete operation should be handled; possible values are:

Alternatively, if Snapshot is non-empty, the specified snapshot of Blob is deleted, and DeleteAction is ignored.

If the current Azure Storage account, specified by Account, has a delete retention policy enabled for the Blob service, then this method will only soft-delete blobs (and snapshots). Soft-deleted blobs and snapshots can be listed by enabling the IncludeSoftDeleted configuration setting before calling ListBlobs, and can be undeleted at any point before their retention period expires by calling UndeleteBlob. This method can alternatively permanently delete blobs and snapshots by enabling the DeletePermanently configuration setting.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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

DeleteContainer Method (AzureBlob Class)

Deletes a container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteContainer();

Unicode (Windows)
INT DeleteContainer();

int cloudstorage_azureblob_deletecontainer(void* lpObj);

int DeleteContainer();

Remarks

This method deletes the container currently selected by Container. Note that, according to the Azure documentation, when a container is deleted its name cannot be reused for at least 30 seconds.

If the current Azure Storage account, specified by Account, has a delete retention policy enabled for the Blob service, then this method will only soft-delete containers. Soft-deleted containers can be listed by enabling the IncludeSoftDeleted configuration setting before calling ListContainers, and can be undeleted at any point before their retention period expires by calling UndeleteContainer.

If the specified container has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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

GetBlob Method (AzureBlob Class)

Downloads a blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlob(const char* lpszBlob);

Unicode (Windows)
INT GetBlob(LPCWSTR lpszBlob);

int cloudstorage_azureblob_getblob(void* lpObj, const char* lpszBlob);

int GetBlob(const QString& qsBlob);

Remarks

This methods downloads the specified Blob in the container currently selected by Container. If Snapshot is non-empty, the specified snapshot of Blob is downloaded instead. The Range property can be used to download a specific range of bytes from the blob.

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

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

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

Download Notes

In the simplest use-case, downloading a blob looks like this: azureblob.LocalFile = "../MyData.zip"; azureblob.GetBlob(azureblob.Blobs[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"; azureblob.LocalFile = downloadFile; azureblob.GetBlob(azureblob.Blobs[0].Name); //The transfer is interrupted and GetBlob() above fails. Later, resume the download: //Get the size of the partially downloaded file azureblob.StartByte = new FileInfo(downloadFile).Length; azureblob.GetBlob(azureblob.Blobs[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. azureblob.LocalFile = "../MyData.zip"; azureblob.EncryptionPassword = "password"; azureblob.GetBlob(azureblob.Blobs[0].Name); //The transfer is interrupted and GetBlob() above fails. Later, resume the download: //Get the size of the partially downloaded temp file azureblob.StartByte = new FileInfo(azureblob.Config("DownloadTempFile")).Length; azureblob.GetBlob(azureblob.Blobs[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.)

GetBlobInfo Method (AzureBlob Class)

Gets a blob's information and metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBlobInfo(const char* lpszBlob);

Unicode (Windows)
INT GetBlobInfo(LPCWSTR lpszBlob);

int cloudstorage_azureblob_getblobinfo(void* lpObj, const char* lpszBlob);

int GetBlobInfo(const QString& qsBlob);

Remarks

This method gets information and metadata for the specified Blob in the container currently selected by Container. If Snapshot is non-empty, information and metadata for the specified snapshot of Blob is retrieved instead.

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

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

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

GetContainerACL Method (AzureBlob Class)

Gets the stored access policies and public access level for a container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContainerACL();

Unicode (Windows)
INT GetContainerACL();

int cloudstorage_azureblob_getcontaineracl(void* lpObj);

int GetContainerACL();

Remarks

This method retrieves the stored access policies and the public access level for the container currently selected by Container. The stored access policies are used to populate the AccessPolicies properties, and the public access level is returned directly. Possible values are:

If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

Error Handling (C++)

This method returns an Integer 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.

GetContainerInfo Method (AzureBlob Class)

Gets a container's information and metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContainerInfo();

Unicode (Windows)
INT GetContainerInfo();

int cloudstorage_azureblob_getcontainerinfo(void* lpObj);

int GetContainerInfo();

Remarks

This method gets information and metadata for the container currently selected by Container.

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

If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

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

GetLink Method (AzureBlob Class)

Creates a link that provides access to a container, blob, or snapshot.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLink(const char* lpszBlob, const char* lpszPermissions, const char* lpszStartTime, const char* lpszExpiryTime);

Unicode (Windows)
LPWSTR GetLink(LPCWSTR lpszBlob, LPCWSTR lpszPermissions, LPCWSTR lpszStartTime, LPCWSTR lpszExpiryTime);

char* cloudstorage_azureblob_getlink(void* lpObj, const char* lpszBlob, const char* lpszPermissions, const char* lpszStartTime, const char* lpszExpiryTime);

QString GetLink(const QString& qsBlob, const QString& qsPermissions, const QString& qsStartTime, const QString& qsExpiryTime);

Remarks

This method creates and returns a shared access signature (SAS), which is a link that provides access to a specific container, blob, or snapshot. The following table indicates which inputs must be provided to produce a link of the desired type:

Permissions specifies what permissions the SAS grants, in the form of an abbreviated permissions list. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format this value.

StartTime and ExpiryTime specify the UTC start and end times of the SAS's validity interval. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format these values.

StartTime may be empty, in which case the server will assume that the link is valid immediately. Permissions and ExpiryTime must both be non-empty, unless an si query parameter that references a stored access policy (which has corresponding non-empty values) is present in the QueryParams properties.

If any of the query parameters listed below are present in the QueryParams properties when this method is called, they will be included when creating the SAS. All other application-specified query parameters are ignored.

• Response headers: rscc, rscd, rsce, rscl, rsct
• IP address (single or range): sip
• Allowed HTTP protocol(s): spr
• Stored access policy ("signed identifier"): si

For more information about SAS links, refer to Azure's Create a Service SAS article.

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.

GetUserDelegationKey Method (AzureBlob Class)

Requests a new user delegation key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetUserDelegationKey(const char* lpszStartTime, const char* lpszExpiryTime);

Unicode (Windows)
INT GetUserDelegationKey(LPCWSTR lpszStartTime, LPCWSTR lpszExpiryTime);

int cloudstorage_azureblob_getuserdelegationkey(void* lpObj, const char* lpszStartTime, const char* lpszExpiryTime);

int GetUserDelegationKey(const QString& qsStartTime, const QString& qsExpiryTime);

Remarks

This method requests a new user delegation key and populates UserDelegationKey with the returned information.

NOTE: This method is not currently implemented; it is reserved for future use.

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

This method interrupts the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

Lease Method (AzureBlob Class)

Creates or manages a lease on a blob or container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Lease(const char* lpszBlob, int iLeaseAction, const char* lpszNewLeaseId, int iDuration);

Unicode (Windows)
INT Lease(LPCWSTR lpszBlob, INT iLeaseAction, LPCWSTR lpszNewLeaseId, INT iDuration);

int cloudstorage_azureblob_lease(void* lpObj, const char* lpszBlob, int iLeaseAction, const char* lpszNewLeaseId, int iDuration);

int Lease(const QString& qsBlob, int iLeaseAction, const QString& qsNewLeaseId, int iDuration);

Remarks

This method creates or manages a lease on the container currently selected by Container (if Blob is empty), or on the specified Blob in that container.

LeaseAction specifies what action should occur. Possible values, and their effects, are:

• Acquire (0): Requests a new lease.
  • If no active lease currently exists, a new one is created and LeaseId is populated with the new lease's Id. If a non-empty value is passed for NewLeaseId, it is used; otherwise the server generates an Id.
  • If an active lease currently exists, its Id must be passed for NewLeaseId.
  • In either case, Duration is used to specify the length of time that the lease is valid for (see below).
• Renew (1): Renews the lease specified by LeaseId.
  • Leases can only be renewed while active or expired (and in the latter case, only if a different lease has not been acquired in the meantime).
  • Renewing an active lease will reset its expiration clock.
• Change (2): Changes the Id of the active lease specified by LeaseId to the one specified by NewLeaseId.
  • If this action is successful, the class will automatically set LeaseId to the value passed for NewLeaseId.
• Release (3): Releases the lease specified by LeaseId.
  • If this action is successful, the class will automatically clear LeaseId.
• Break (4): Breaks the current lease, either immediately or after a certain period of time (the "break period") according to the value passed for Duration.
  • The lease's Id is not required to break the lease.
  • If Duration is -1, fixed-length leases are broken after their remaining time elapses, and infinite-length leases are broken immediately.
  • Otherwise, Duration specified how many seconds (see below) the lease should continue before being broken. (For fixed-length leases, the lesser of this value and the lease's remaining time is used.)
  • If this action is successful, the LeaseBreakPeriod configuration setting is populated to indicate how long the lease's break period is.

If NewLeaseId is non-empty, if must be a GUID string formatted in one of the styles described by Microsoft's .NET Guid(string) constructor documentation. For example: dddddddd-dddd-dddd-dddd-dddddddddddd, where each d is a single case-insensitive hex digit.

The value passed for Duration is only used in the cases listed below; it is ignored otherwise.

• When LeaseAction is Acquire (0): Valid values for Duration are -1 (infinite), or a number of seconds between 15 and 60 (inclusive).
• When LeaseAction is Break (4): Valid values for Duration are -1 (unspecified), or a number of seconds between 0 and 60 (inclusive). 0 indicates the lease should be broken immediately, regardless of whether it is fixed- or infinite-length.

For more information about how leases work, refer to Azure's Lease Blob and Lease Container API documentation.

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

ListBlobs Method (AzureBlob Class)

Lists the blobs in a container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListBlobs();

Unicode (Windows)
INT ListBlobs();

int cloudstorage_azureblob_listblobs(void* lpObj);

int ListBlobs();

Remarks

This method lists the blobs in the container currently selected by Container.

Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned. The following properties and configuration settings can also be used to further tune the results returned; refer to their documentation for more information:

• BlobDelimiter
• IncludeSnapshots
• IncludeSoftDeleted
• IncludeUncommittedBlobs
• ListWithMetadata

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

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

Blob Namespace Traversal

By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:

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

With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs 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.)

ListBlocks Method (AzureBlob Class)

Lists the blocks associated with a block blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListBlocks(const char* lpszBlockBlob, int iBlockListType);

Unicode (Windows)
INT ListBlocks(LPCWSTR lpszBlockBlob, INT iBlockListType);

int cloudstorage_azureblob_listblocks(void* lpObj, const char* lpszBlockBlob, int iBlockListType);

int ListBlocks(const QString& qsBlockBlob, int iBlockListType);

Remarks

This method lists the blocks associated with the specified BlockBlob in the container currently selected by Container. BlockListType indicates which block list(s) the server should return results from; possible values are:

Alternatively, if Snapshot is non-empty, the committed blocks for the specified snapshot of BlockBlob are listed instead (and BlockListType is ignored).

Calling this method will fire the BlockList event once for each block, and will also repopulate the Blocks 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.)

ListContainers Method (AzureBlob Class)

Lists the containers in the blob storage account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListContainers();

Unicode (Windows)
INT ListContainers();

int cloudstorage_azureblob_listcontainers(void* lpObj);

int ListContainers();

Remarks

This method lists the containers in the Azure blob storage account specified by the Account property.

Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned. The ListWithMetadata and IncludeSoftDeleted configuration settings can also be used to further tune the results returned.

Calling this method will fire the ContainerList event once for each container, and will also populate the Containers properties. It may also fire the MetadataList event, depending on how the ListWithMetadata setting is configured.

If there are still more containers available to list when this method returns, the ContainerMarker property will be populated. Continue to call this method until ContainerMarker is empty to accumulate all pages of results in the Containers 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.)

ListPageRanges Method (AzureBlob Class)

Lists the page ranges of a page blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListPageRanges(const char* lpszPageBlob);

Unicode (Windows)
INT ListPageRanges(LPCWSTR lpszPageBlob);

int cloudstorage_azureblob_listpageranges(void* lpObj, const char* lpszPageBlob);

int ListPageRanges(const QString& qsPageBlob);

Remarks

This method lists the allocated page ranges of the specified PageBlob in the container currently selected by Container. If Snapshot is non-empty, the allocated page ranges for the specified snapshot of PageBlob are listed instead.

The Range property can be used to restrict the results to only the page ranges within the specified range.

Calling this method will repopulate the PageRanges properties. Every page in a page blob is exactly 512 bytes in length; thus, the size of every range returned by this method will always be a multiple of 512.

Normally, ranges of pages that are not currently allocated (either because no data has been written to them, or because they've been cleared with ClearPages) will not be returned by this method. However, setting the PreviousSnapshot configuration setting to a non-empty value will cause the server to return a list of all pages that differ between that snapshot and the base PageBlob (or the later snapshot of PageBlob specified by Snapshot); refer to PreviousSnapshot for more information.

If the specified blob has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

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

PutBlock Method (AzureBlob Class)

Uploads a new block of data to a block blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* PutBlock(const char* lpszBlockBlob, const char* lpszBlockId);

Unicode (Windows)
LPWSTR PutBlock(LPCWSTR lpszBlockBlob, LPCWSTR lpszBlockId);

char* cloudstorage_azureblob_putblock(void* lpObj, const char* lpszBlockBlob, const char* lpszBlockId);

QString PutBlock(const QString& qsBlockBlob, const QString& qsBlockId);

Remarks

This method uploads a new block of data with the given BlockId to the specified BlockBlob in the container currently selected by Container. The block of data is uploaded in an uncommitted state; it will not be available as part of the block blob until it is committed in a PutBlockList operation.

The Base64-encoded Id of the block is returned (if the EncodeBlockIds configuration setting is disabled, the same value as passed for BlockId is returned; see below for more information).

If the specified BlockBlob does not yet exist, it is created in an uncommitted state. If an uncommitted block with the specified BlockId is already associated with the specified BlockBlob, it is replaced.

Block Ids must be Base64-encoded when sent to the server. By default, the class will automatically Base64-encode block Ids as they are sent, and Base64-decode them as they are received. This behavior can be configured using the EncodeBlockIds configuration setting.

All block Ids must be less than or equal to 64 bytes in length before being Base64-encoded. Additionally, all blocks Ids within a single block blob must be unique, and of the exact same length after Base64-encoding.

Up to 100MB (104857600 bytes) of data may be uploaded in a single block, and up to 100000 uncommitted blocks may be associated with a block blob at any time.

If the block is successfully uploaded, the class will automatically call AddBlock to add an item to the Blocks properties. This behavior can be changed using the AutoAddBlocks configuration setting.

If BlockBlob already exists and has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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.

PutBlockList Method (AzureBlob Class)

Commits a list of data blocks to a block blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PutBlockList(const char* lpszBlockBlob, const char* lpszBlockList);

Unicode (Windows)
INT PutBlockList(LPCWSTR lpszBlockBlob, LPCWSTR lpszBlockList);

int cloudstorage_azureblob_putblocklist(void* lpObj, const char* lpszBlockBlob, const char* lpszBlockList);

int PutBlockList(const QString& qsBlockBlob, const QString& qsBlockList);

Remarks

This method commits the blocks of data specified by the Blocks properties to the specified BlockBlob in the container currently selected by Container. Up to 50000 blocks may be committed to a single block blob at any time.

The BlockList parameter can optionally be passed a non-empty list of blocks to commit in order to repopulate the Blocks properties before building the request. This allows applications to build an entire block list and then commit it in a single call, rather than manipulating the Blocks properties directly, or calling AddBlock.

The value supplied should contain a comma-separated list of strings like {BlockListType}:{BlockId}, where {BlockListType} is either C, U, or L to specify whether the server should search for a block with the associated Id in BlockBlob's committed block list, uncommitted block list, or both (uncommitted; then committed, if necessary). If necessary, the BlockListStringSeparator configuration setting can be used to change the separator string used when parsing the value.

If BlockList is empty, the current items in the Blocks properties will remain unchanged.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

Note: By default, the class will automatically retrieve and re-submit the BlockBlob's current properties and metadata (if it exists) when this method is called, since Azure would clear them otherwise.

However, if one or more x-ms-blob-* headers are present in OtherHeaders when this method is called, the class will send them rather than re-submitting any of the retrieved blob properties. Similarly, if the SendMetadataOnPutBlockList configuration setting is enabled, the class will send the metadata items currently present in the Metadata properties instead of those retrieved from 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.)

PutPages Method (AzureBlob Class)

Uploads a range of pages to a page blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PutPages(const char* lpszPageBlob, int64 lWriteOffset);

Unicode (Windows)
INT PutPages(LPCWSTR lpszPageBlob, LONG64 lWriteOffset);

int cloudstorage_azureblob_putpages(void* lpObj, const char* lpszPageBlob, int64 lWriteOffset);

int PutPages(const QString& qsPageBlob, qint64 lWriteOffset);

Remarks

This method uploads a range of pages to the specified PageBlob in the container currently selected by Container, starting at the byte offset specified by WriteOffset. The uploaded data is immediately available as part of the page blob, which must already exist.

The upload data's size, in bytes, must be a multiple of 512 no larger than 4MB (4194304 bytes). The value passed for WriteOffset must also be a multiple of 512; WriteOffset % == 0.

Note that writing a page full of zeros will not actually clear said page, so it will still incur data storage charges. It is recommended that applications avoid writing pages that only contain zeros, or clear such pages using the ClearPages method.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

SendCustomRequest Method (AzureBlob Class)

Sends a custom request to the Azure Blob Storage service.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azureblob_sendcustomrequest(void* lpObj, const char* lpszHttpMethod, const char* lpszBlob, const char* lpszRequestBody);

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

Remarks

This method can be used to send arbitrary requests to the Azure Blob Storage service.

Valid values for HttpMethod are:

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

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

Usage

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

1. Builds a request URL, including query parameters, using the following:
   • UseSSL
   • Account (must be non-empty)
   • Container (if non-empty)
   • Blob (if non-empty)
   • Snapshot (if both it and Blob are non-empty)
   • QueryParams
2. Adds request headers from:
   • APIVersion
   • LeaseId (if non-empty)
   • IfMatch (if non-empty)
   • OtherHeaders
3. Authenticates the request using Authorization (if non-empty), or AccessKey (in which case the request is signed).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeaders properties; and the response body in the stream specified using SetDownloadStream, the specified LocalFile, or BlobData (using the same logic as GetBlob).

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

Error Handling (C++)

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

SetContainerACL Method (AzureBlob Class)

Sets the stored access policies and public access level for a container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetContainerACL(int iPublicAccess);

Unicode (Windows)
INT SetContainerACL(INT iPublicAccess);

int cloudstorage_azureblob_setcontaineracl(void* lpObj, int iPublicAccess);

int SetContainerACL(int iPublicAccess);

Remarks

This method sets the stored access policies and the public access level for the container currently specified by Container. The items in the AccessPolicies properties determine the new set of stored access policies, and PublicAccess determines the new public access level. Possible values are:

Note that it is not possible to do a partial update of stored access policies. That is, all stored access policies currently associated with the container will be replaced with the stored access policies sent in the request. To prevent data loss, applications should call GetContainerACL to retrieve the container's current stored access polices, and then add/modify/remove them as desired, before using this method.

If the specified container has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified.

Error Handling (C++)

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

SetDownloadStream Method (AzureBlob Class)

Sets the stream to which downloaded data will be written.

Syntax

• C++
• C
• Qt

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

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

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

int SetDownloadStream(CloudStorageStream* sDownloadStream);

Remarks

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

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

Error Handling (C++)

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

SetUploadStream Method (AzureBlob Class)

Sets the stream from which data is read when uploading.

Syntax

• C++
• C
• Qt

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

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

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

int SetUploadStream(CloudStorageStream* sUploadStream);

Remarks

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

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

Error Handling (C++)

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

UndeleteBlob Method (AzureBlob Class)

Undeletes a soft-deleted blob.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UndeleteBlob(const char* lpszBlob);

Unicode (Windows)
INT UndeleteBlob(LPCWSTR lpszBlob);

int cloudstorage_azureblob_undeleteblob(void* lpObj, const char* lpszBlob);

int UndeleteBlob(const QString& qsBlob);

Remarks

This method undeletes the specified soft-deleted Blob in the container currently selected by Container. If any soft-deleted snapshots are associated with the specified blob, they are also undeleted (note that this also works if the blob itself has not been soft-deleted).

Refer to DeleteBlob for more information about soft-deleting blobs.

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

UndeleteContainer Method (AzureBlob Class)

Undeletes a soft-deleted container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UndeleteContainer(const char* lpszContainer, const char* lpszDeletedVersion);

Unicode (Windows)
INT UndeleteContainer(LPCWSTR lpszContainer, LPCWSTR lpszDeletedVersion);

int cloudstorage_azureblob_undeletecontainer(void* lpObj, const char* lpszContainer, const char* lpszDeletedVersion);

int UndeleteContainer(const QString& qsContainer, const QString& qsDeletedVersion);

Remarks

This method undeletes the specified soft-deleted Container with the supplied DeletedVersion. If any soft-deleted blobs and snapshots are associated with the specified container, they are also undeleted, but note that soft-deleted blobs can only be restored in this manner if the container itself was also deleted.

Refer to DeleteContainer for more information about soft-deleting containers.

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

UpdateBlobInfo Method (AzureBlob Class)

Updates a blob's information.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateBlobInfo(const char* lpszBlob);

Unicode (Windows)
INT UpdateBlobInfo(LPCWSTR lpszBlob);

int cloudstorage_azureblob_updateblobinfo(void* lpObj, const char* lpszBlob);

int UpdateBlobInfo(const QString& qsBlob);

Remarks

This method updates the information of the specified Blob in the container currently selected by Container.

There must be an AzureBlobBlob properties whose Name field matches the specified Blob name (and whose Snapshot field is empty) before this method is called.

When this method is called, the values of the following fields on the aforementioned item are sent to the server (note that the last two are indexed configuration settings):

• ContentDisposition
• ContentEncoding
• ContentMD5
• ContentType
• BlobCacheControl[i]
• BlobContentLanguage[i]

Note that it is not possible to do a partial update of a blob's information. That is, all of the blob's current values for the aforementioned fields will be replaced with the values sent in the request. To prevent data loss, applications should call GetBlobInfo to retrieve the blob's current information, and then modify it as desired, before using this method.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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

UpdateMetadata Method (AzureBlob Class)

Sets the metadata for a blob or container.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateMetadata(const char* lpszBlob);

Unicode (Windows)
INT UpdateMetadata(LPCWSTR lpszBlob);

int cloudstorage_azureblob_updatemetadata(void* lpObj, const char* lpszBlob);

int UpdateMetadata(const QString& qsBlob);

Remarks

This method sets the metadata for the container currently selected by Container (if Blob is empty), or for the specified Blob in that container, to the items currently held by the Metadata properties.

Note that it is not possible to do a partial metadata update. That is, all metadata currently associated with the blob or container will be replaced with the metadata sent in the request. To prevent data loss, applications should call GetBlobInfo or GetContainerInfo to retrieve the blob or container's current metadata, and then modify it as desired, before using this method.

When setting the metadata of a container that has an active lease, a lease Id may optionally be specified using LeaseId; the request will only succeed if the correct lease Id is specified. When setting the metadata of a blob that has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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

UpdatePageBlob Method (AzureBlob Class)

Updates a page blob's size and/or sequence number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdatePageBlob(const char* lpszPageBlob, int64 lNewSize, int iSequenceNumAction, int64 lNewSequenceNum);

Unicode (Windows)
INT UpdatePageBlob(LPCWSTR lpszPageBlob, LONG64 lNewSize, INT iSequenceNumAction, LONG64 lNewSequenceNum);

int cloudstorage_azureblob_updatepageblob(void* lpObj, const char* lpszPageBlob, int64 lNewSize, int iSequenceNumAction, int64 lNewSequenceNum);

int UpdatePageBlob(const QString& qsPageBlob, qint64 lNewSize, int iSequenceNumAction, qint64 lNewSequenceNum);

Remarks

This method updates the size and/or sequence number of the specified PageBlob in the container currently selected by Container.

NewSize must either be -1 (to keep the page blob's current size), or a multiple of 512; i.e. NewSize % 512 == 0. If NewSize is less than the page blob's current size, all pages above the specified value are cleared.

SequenceNumAction determines how the page blob's sequence number should be changed; possible values are:

In cases where NewSequenceNum is used, it must be a value in the range 0 to 2^63 - 1, inclusive.

If the specified blob has an active lease, its lease Id must be specified using LeaseId, or the request will fail.

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

BlobList Event (AzureBlob Class)

Fires once for each blob returned when listing blobs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBlobList(AzureBlobBlobListEventParams *e);

typedef struct {
  const char *Name;
  const char *Container;
  int BlobType;
  const char *Snapshot;
  int64 ContentLength;
  const char *ContentType;
  const char *CreatedTime;
  const char *ModifiedTime;
  const char *ETag;
  int SoftDeleted;
  int IsLeased;
  int LeaseState;
  int reserved;
} AzureBlobBlobListEventParams;


Unicode (Windows)
virtual INT FireBlobList(AzureBlobBlobListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Container;
  INT BlobType;
  LPCWSTR Snapshot;
  LONG64 ContentLength;
  LPCWSTR ContentType;
  LPCWSTR CreatedTime;
  LPCWSTR ModifiedTime;
  LPCWSTR ETag;
  BOOL SoftDeleted;
  BOOL IsLeased;
  INT LeaseState;
  INT reserved;
} AzureBlobBlobListEventParams;

#define EID_AZUREBLOB_BLOBLIST 1

virtual INT CLOUDSTORAGE_CALL FireBlobList(LPSTR &lpszName, LPSTR &lpszContainer, INT &iBlobType, LPSTR &lpszSnapshot, LONG64 &lContentLength, LPSTR &lpszContentType, LPSTR &lpszCreatedTime, LPSTR &lpszModifiedTime, LPSTR &lpszETag, BOOL &bSoftDeleted, BOOL &bIsLeased, INT &iLeaseState);

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

  const QString &Container();

  int BlobType();

  const QString &Snapshot();

  qint64 ContentLength();

  const QString &ContentType();

  const QString &CreatedTime();

  const QString &ModifiedTime();

  const QString &ETag();

  bool SoftDeleted();

  bool IsLeased();

  int LeaseState();

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

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

// Or, subclass AzureBlob and override this emitter function.
virtual int FireBlobList(AzureBlobBlobListEventParams *e) {...}

Remarks

This event fires once for each blob returned when ListBlobs or GetBlobInfo is called.

Name is the name of the blob.

Container is the name of the blob's container.

BlobType is the blob's type. Possible values are:

Refer to Azure's Understanding block blobs, append blobs, and page blobs article for more information about blob types.

Snapshot is the snapshot identifier, if the current item represents a blob snapshot; empty otherwise.

ContentLength is the size of the blob's committed data in bytes, for block blobs and append blobs. For page blobs, its the capacity in bytes.

ContentType is the blob's content type. Always empty for uncommitted block blobs.

CreatedTime and ModifiedTime reflect the creation and last modified times of the blob, formatted according to RFC 1123. The latter is always empty for uncommitted block blobs.

ETag is the blob's ETag. Always empty for uncommitted block blobs.

SoftDeleted indicates whether the blob (or snapshot, if Snapshot is non-empty) has been soft-deleted.

IsLeased indicates whether the blob is currently leased. Always false if SoftDeleted is true and/or Snapshot is non-empty.

LeaseState reflects the lease state of the blob. Possible values are:

BlockList Event (AzureBlob Class)

Fires once for each block returned when listing blocks.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBlockList(AzureBlobBlockListEventParams *e);

typedef struct {
  const char *Id;
  int BlockType;
  int Size;
  int reserved;
} AzureBlobBlockListEventParams;


Unicode (Windows)
virtual INT FireBlockList(AzureBlobBlockListEventParams *e);

typedef struct {
  LPCWSTR Id;
  INT BlockType;
  INT Size;
  INT reserved;
} AzureBlobBlockListEventParams;

#define EID_AZUREBLOB_BLOCKLIST 2

virtual INT CLOUDSTORAGE_CALL FireBlockList(LPSTR &lpszId, INT &iBlockType, INT &iSize);

class AzureBlobBlockListEventParams {
public:
  const QString &Id();

  int BlockType();

  int Size();

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

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

// Or, subclass AzureBlob and override this emitter function.
virtual int FireBlockList(AzureBlobBlockListEventParams *e) {...}

Remarks

This event fires once for each block returned when ListBlocks is called.

Id is the Id of the block.

BlockType reflects the block's type; possible values are:

• abktCommitted (0)
• abktUncommitted (1)

Size reflects the size of the block, in bytes.

ContainerList Event (AzureBlob Class)

Fires once for each container returned when listing containers.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireContainerList(AzureBlobContainerListEventParams *e);

typedef struct {
  const char *Name;
  const char *ModifiedTime;
  const char *ETag;
  int IsLeased;
  int LeaseState;
  int reserved;
} AzureBlobContainerListEventParams;


Unicode (Windows)
virtual INT FireContainerList(AzureBlobContainerListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR ModifiedTime;
  LPCWSTR ETag;
  BOOL IsLeased;
  INT LeaseState;
  INT reserved;
} AzureBlobContainerListEventParams;

#define EID_AZUREBLOB_CONTAINERLIST 3

virtual INT CLOUDSTORAGE_CALL FireContainerList(LPSTR &lpszName, LPSTR &lpszModifiedTime, LPSTR &lpszETag, BOOL &bIsLeased, INT &iLeaseState);

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

  const QString &ModifiedTime();

  const QString &ETag();

  bool IsLeased();

  int LeaseState();

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

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

// Or, subclass AzureBlob and override this emitter function.
virtual int FireContainerList(AzureBlobContainerListEventParams *e) {...}

Remarks

This event fires once for each container returned when ListContainers or GetContainerInfo is called.

Name is the name of the container.

ModifiedTime reflects the last modified time of the container, formatted according to RFC 1123.

ETag is the container's ETag.

IsLeased indicates whether the container is currently leased.

LeaseState reflects the lease state of the container. Possible values are:

EndTransfer Event (AzureBlob Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREBLOB_ENDTRANSFER 4

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class AzureBlobEndTransferEventParams {
public:
  int Direction();

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

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

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