AzureFile Class

Properties   Methods   Events   Config Settings   Errors  

The AzureFile class provides an easy to use interface to Microsoft's Azure File Storage service.

Syntax

AzureFile

Remarks

The AzureFile class offers an easy-to-use API for the Microsoft Azure File Storage service. Capabilities include uploading and downloading files, strong encryption support, creating folders, file manipulation, 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.

Addressing Resources

Azure File Storage accounts can contain one or more file shares. Use the ListShares method to list available shares, and select which one the class should operate against using the Share property.

After selecting a share, address the files and folders within it using Linux-style absolute paths. Unless otherwise specified, the class always works in terms of absolute paths, and will always prepend a forward slash (/) to any path passed to it that does not already start with one.

Listing Directory Contents

ListResources lists resources (files and folders) within the specified directory. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resource* properties. // ResourceList event handler. azurefile.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; azurefile.Share = "myshare"; do { azurefile.ListResources("/work_files/serious_business/cats"); for (int i = 0; i < azurefile.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(azurefile.ResourceMarker));

Downloading Files

The DownloadFile method downloads files.

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

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

Download Notes

In the simplest use-case, downloading a file looks like this: azurefile.LocalFile = "../MyFile.zip"; azurefile.DownloadFile(azurefile.Resources[0].Path);

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 = "../MyFile.zip"; azurefile.LocalFile = downloadFile; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file azurefile.StartByte = new FileInfo(downloadFile).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

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. azurefile.LocalFile = "../MyFile.zip"; azurefile.EncryptionPassword = "password"; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file azurefile.StartByte = new FileInfo(azurefile.Config("DownloadTempFile")).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

Uploading Files

The UploadFile method uploads new files.

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

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

Upload Notes

The UploadFile method is a convenience method that performs a resumable file upload. When called, the class first uses CreateFile to initialize a new file entry on the server; and then it fragments the file data into smaller pieces and calls PutRange multiple times in succession to upload those fragments. The fragment size is fixed at 4MB (this is a server limitation that cannot be changed).

During the upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset. azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. azurefile.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); azurefile.SetUploadStream(uploadStream); azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; azurefile.UploadFile("MyFile.zip");

Additional Functionality

The AzureFile class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
• Basic file and folder manipulation and organization using methods such as CreateFolder, CopyFile, DeleteFolder, and DeleteFile.
• Advanced file manipulation with CreateFile, ResizeFile, PutRange, GetRanges, and ClearRange.
• Share manipulation with CreateShare, SetShareQuota, and DeleteShare.
• Retrieval of information and metadata for files, folders, and shares using GetFileInfo, GetFolderInfo, and GetShareInfo.
• And more!

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 (AzureFile 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_azurefile_getaccesskey(void* lpObj);
int cloudstorage_azurefile_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.

This property is not available at design time.

Data Type

String

Account Property (AzureFile 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_azurefile_getaccount(void* lpObj);
int cloudstorage_azurefile_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

EncryptionAlgorithm Property (AzureFile 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_azurefile_getencryptionalgorithm(void* lpObj);
int cloudstorage_azurefile_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 (AzureFile 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_azurefile_getencryptionpassword(void* lpObj);
int cloudstorage_azurefile_setencryptionpassword(void* lpObj, const char* lpszEncryptionPassword);

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

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getfirewallautodetect(void* lpObj);
int cloudstorage_azurefile_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (AzureFile Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_azurefile_getfirewalltype(void* lpObj);
int cloudstorage_azurefile_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getfirewallhost(void* lpObj);
int cloudstorage_azurefile_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getfirewallpassword(void* lpObj);
int cloudstorage_azurefile_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getfirewallport(void* lpObj);
int cloudstorage_azurefile_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getfirewalluser(void* lpObj);
int cloudstorage_azurefile_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

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

Data Type

String

Idle Property (AzureFile Class)

The current status of the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();

int cloudstorage_azurefile_getidle(void* lpObj);

bool GetIdle();

Default Value

TRUE

Remarks

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

This property is read-only.

Data Type

Boolean

LocalFile Property (AzureFile 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_azurefile_getlocalfile(void* lpObj);
wchar_t* cloudstorage_azurefile_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_azurefile_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_azurefile_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 UploadFile or PutRange, and as the destination file when calling DownloadFile.

Note that if SetUploadStream or SetDownloadStream is called, the specified stream will be used instead of the file set here.

Data Type

String

LocalHost Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getlocalhost(void* lpObj);
int cloudstorage_azurefile_setlocalhost(void* lpObj, const char* lpszLocalHost);

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

Default Value

""

Remarks

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

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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

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

Data Type

String

MetadataCount Property (AzureFile Class)

The number of records in the Metadata arrays.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getmetadatacount(void* lpObj);
int cloudstorage_azurefile_setmetadatacount(void* lpObj, int iMetadataCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

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

This property is not available at design time.

Data Type

Integer

MetadataName Property (AzureFile Class)

The name of the metadata item.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getmetadataname(void* lpObj, int metadataindex);
int cloudstorage_azurefile_setmetadataname(void* lpObj, int metadataindex, const char* lpszMetadataName);

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

Default Value

""

Remarks

The name of the metadata item.

This property specifies the name of the metadata item. Note that metadata item names are case-preserving, but not case-sensitive.

Note that the class will automatically prepend x-ms-meta- to this value when submitting metadata items to the server; and will automatically strip that prefix from this value when retrieving them from the server.

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

This property is not available at design time.

Data Type

String

MetadataValue Property (AzureFile Class)

The value of the metadata item.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getmetadatavalue(void* lpObj, int metadataindex);
int cloudstorage_azurefile_setmetadatavalue(void* lpObj, int metadataindex, const char* lpszMetadataValue);

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

Default Value

""

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

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

This property is not available at design time.

Data Type

String

OtherHeaders Property (AzureFile 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_azurefile_getotherheaders(void* lpObj);
int cloudstorage_azurefile_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 (AzureFile Class)

Determines if local files are overwritten.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getoverwrite(void* lpObj);
int cloudstorage_azurefile_setoverwrite(void* lpObj, int bOverwrite);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (AzureFile Class)

The number of records in the ParsedHeader arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetParsedHeaderCount();

Unicode (Windows)
INT GetParsedHeaderCount();

int cloudstorage_azurefile_getparsedheadercount(void* lpObj);

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetParsedHeaderField(INT iParsedHeaderIndex);

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

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

ParsedHeaderValue Property (AzureFile Class)

This property contains the header contents.

Syntax

• C++
• C
• Qt

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

Unicode (Windows)
LPWSTR GetParsedHeaderValue(INT iParsedHeaderIndex);

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

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

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

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

Data Type

String

Prefix Property (AzureFile Class)

A prefix used to restrict the results returned when listing resources or shares.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getprefix(void* lpObj);
int cloudstorage_azurefile_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 ListResources or ListShares to only the items whose names begin with the given value.

This property is not available at design time.

Data Type

String

ProxyAuthScheme Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_azurefile_getproxyauthscheme(void* lpObj);
int cloudstorage_azurefile_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

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

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getproxyautodetect(void* lpObj);
int cloudstorage_azurefile_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getproxypassword(void* lpObj);
int cloudstorage_azurefile_setproxypassword(void* lpObj, const char* lpszProxyPassword);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getproxyport(void* lpObj);
int cloudstorage_azurefile_setproxyport(void* lpObj, int iProxyPort);

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

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getproxyserver(void* lpObj);
int cloudstorage_azurefile_setproxyserver(void* lpObj, const char* lpszProxyServer);

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

Default Value

""

Remarks

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

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

Data Type

String

ProxySSL Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_azurefile_getproxyssl(void* lpObj);
int cloudstorage_azurefile_setproxyssl(void* lpObj, int iProxySSL);

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

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getproxyuser(void* lpObj);
int cloudstorage_azurefile_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

QueryParamCount Property (AzureFile Class)

The number of records in the QueryParam arrays.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getqueryparamcount(void* lpObj);
int cloudstorage_azurefile_setqueryparamcount(void* lpObj, int iQueryParamCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

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

This property is not available at design time.

Data Type

Integer

QueryParamName Property (AzureFile Class)

The name of the query parameter.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getqueryparamname(void* lpObj, int queryparamindex);
int cloudstorage_azurefile_setqueryparamname(void* lpObj, int queryparamindex, const char* lpszQueryParamName);

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

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

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

This property is not available at design time.

Data Type

String

QueryParamValue Property (AzureFile Class)

The value of the query parameter.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getqueryparamvalue(void* lpObj, int queryparamindex);
int cloudstorage_azurefile_setqueryparamvalue(void* lpObj, int queryparamindex, const char* lpszQueryParamValue);

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

Default Value

""

Remarks

The value of the query parameter.

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

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

This property is not available at design time.

Data Type

String

RangeCount Property (AzureFile Class)

The number of records in the Range arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRangeCount();

Unicode (Windows)
INT GetRangeCount();

int cloudstorage_azurefile_getrangecount(void* lpObj);

int GetRangeCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• RangeFirst
• RangeLast

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

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

Data Type

Integer

RangeFirst Property (AzureFile Class)

The first byte of the range.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetRangeFirst(int iRangeIndex);

Unicode (Windows)
LONG64 GetRangeFirst(INT iRangeIndex);

int64 cloudstorage_azurefile_getrangefirst(void* lpObj, int rangeindex);

qint64 GetRangeFirst(int iRangeIndex);

Default Value

0

Remarks

The first byte of the range.

This property specifies the first byte (inclusive) of the byte range.

The RangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.

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

Data Type

Long64

RangeLast Property (AzureFile Class)

The last byte of the range.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetRangeLast(int iRangeIndex);

Unicode (Windows)
LONG64 GetRangeLast(INT iRangeIndex);

int64 cloudstorage_azurefile_getrangelast(void* lpObj, int rangeindex);

qint64 GetRangeLast(int iRangeIndex);

Default Value

0

Remarks

The last byte of the range.

This property specifies the last byte (inclusive) of the byte range.

The RangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.

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

Data Type

Long64

ResourceData Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceData(char* &lpResourceData, int &lenResourceData);
int SetResourceData(const char* lpResourceData, int lenResourceData);

Unicode (Windows)
INT GetResourceData(LPSTR &lpResourceData, INT &lenResourceData);
INT SetResourceData(LPCSTR lpResourceData, INT lenResourceData);

int cloudstorage_azurefile_getresourcedata(void* lpObj, char** lpResourceData, int* lenResourceData);
int cloudstorage_azurefile_setresourcedata(void* lpObj, const char* lpResourceData, int lenResourceData);

QByteArray GetResourceData();
int SetResourceData(QByteArray qbaResourceData);

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

ResourceMarker Property (AzureFile Class)

A marker indicating what page of resources to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceMarker();
int SetResourceMarker(const char* lpszResourceMarker);

Unicode (Windows)
LPWSTR GetResourceMarker();
INT SetResourceMarker(LPCWSTR lpszResourceMarker);

char* cloudstorage_azurefile_getresourcemarker(void* lpObj);
int cloudstorage_azurefile_setresourcemarker(void* lpObj, const char* lpszResourceMarker);

QString GetResourceMarker();
int SetResourceMarker(QString qsResourceMarker);

Default Value

""

Remarks

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

Refer to ListResources for more information.

This property is not available at design time.

Data Type

String

ResourceCount Property (AzureFile Class)

The number of records in the Resource arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceCount();

Unicode (Windows)
INT GetResourceCount();

int cloudstorage_azurefile_getresourcecount(void* lpObj);

int GetResourceCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ResourceContentMD5
• ResourceContentType
• ResourceETag
• ResourceModifiedTime
• ResourceName
• ResourcePath
• ResourceShare
• ResourceSize
• ResourceType

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

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

Data Type

Integer

ResourceContentMD5 Property (AzureFile Class)

An MD5 hash of the file's content.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceContentMD5(int iResourceIndex);

Unicode (Windows)
LPWSTR GetResourceContentMD5(INT iResourceIndex);

char* cloudstorage_azurefile_getresourcecontentmd5(void* lpObj, int resourceindex);

QString GetResourceContentMD5(int iResourceIndex);

Default Value

""

Remarks

An MD5 hash of the file's content.

This property reflects the MD5 hash of the file's content, if one is returned by the server. Always empty for folders.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceContentType Property (AzureFile Class)

The content type of the resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceContentType(int iResourceIndex);

Unicode (Windows)
LPWSTR GetResourceContentType(INT iResourceIndex);

char* cloudstorage_azurefile_getresourcecontenttype(void* lpObj, int resourceindex);

QString GetResourceContentType(int iResourceIndex);

Default Value

""

Remarks

The content type of the resource.

This property reflects the content type of the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceETag Property (AzureFile Class)

The ETag of the resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceETag(int iResourceIndex);

Unicode (Windows)
LPWSTR GetResourceETag(INT iResourceIndex);

char* cloudstorage_azurefile_getresourceetag(void* lpObj, int resourceindex);

QString GetResourceETag(int iResourceIndex);

Default Value

""

Remarks

The ETag of the resource.

This property reflects the ETag of the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceModifiedTime Property (AzureFile Class)

The last modified time of the resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceModifiedTime(int iResourceIndex);

Unicode (Windows)
LPWSTR GetResourceModifiedTime(INT iResourceIndex);

char* cloudstorage_azurefile_getresourcemodifiedtime(void* lpObj, int resourceindex);

QString GetResourceModifiedTime(int iResourceIndex);

Default Value

""

Remarks

The last modified time of the resource.

This property reflects the last modified time of the resource, formatted according to RFC 1233.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceName Property (AzureFile Class)

The name of the resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceName(int iResourceIndex);

Unicode (Windows)
LPWSTR GetResourceName(INT iResourceIndex);

char* cloudstorage_azurefile_getresourcename(void* lpObj, int resourceindex);

QString GetResourceName(int iResourceIndex);

Default Value

""

Remarks

The name of the resource.

This property reflects the name of the resource.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourcePath Property (AzureFile Class)

The path of the resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourcePath(int iResourceIndex);

Unicode (Windows)
LPWSTR GetResourcePath(INT iResourceIndex);

char* cloudstorage_azurefile_getresourcepath(void* lpObj, int resourceindex);

QString GetResourcePath(int iResourceIndex);

Default Value

""

Remarks

The path of the resource.

This property reflects the path of the resource (not including the name of the share it resides in; see ResourceShare).

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceShare Property (AzureFile Class)

The name of the share the resource resides in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetResourceShare(int iResourceIndex);

Unicode (Windows)
LPWSTR GetResourceShare(INT iResourceIndex);

char* cloudstorage_azurefile_getresourceshare(void* lpObj, int resourceindex);

QString GetResourceShare(int iResourceIndex);

Default Value

""

Remarks

The name of the share the resource resides in.

This property reflects the name of the share the resource resides in.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

String

ResourceSize Property (AzureFile Class)

The size of the file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetResourceSize(int iResourceIndex);

Unicode (Windows)
LONG64 GetResourceSize(INT iResourceIndex);

int64 cloudstorage_azurefile_getresourcesize(void* lpObj, int resourceindex);

qint64 GetResourceSize(int iResourceIndex);

Default Value

0

Remarks

The size of the file.

This property reflects the size, in bytes, of the file resource. Always 0 for folders.

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Long64

ResourceType Property (AzureFile Class)

The resource's type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetResourceType(int iResourceIndex);

Unicode (Windows)
INT GetResourceType(INT iResourceIndex);

AFRT_FILE(0), 
AFRT_FOLDER(1)

int cloudstorage_azurefile_getresourcetype(void* lpObj, int resourceindex);

int GetResourceType(int iResourceIndex);

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.

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

Data Type

Integer

Share Property (AzureFile Class)

Selects a share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShare();
int SetShare(const char* lpszShare);

Unicode (Windows)
LPWSTR GetShare();
INT SetShare(LPCWSTR lpszShare);

char* cloudstorage_azurefile_getshare(void* lpObj);
int cloudstorage_azurefile_setshare(void* lpObj, const char* lpszShare);

QString GetShare();
int SetShare(QString qsShare);

Default Value

""

Remarks

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

Share Name Rules

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

ShareMarker Property (AzureFile Class)

A marker indicating what page of shares to return next.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShareMarker();
int SetShareMarker(const char* lpszShareMarker);

Unicode (Windows)
LPWSTR GetShareMarker();
INT SetShareMarker(LPCWSTR lpszShareMarker);

char* cloudstorage_azurefile_getsharemarker(void* lpObj);
int cloudstorage_azurefile_setsharemarker(void* lpObj, const char* lpszShareMarker);

QString GetShareMarker();
int SetShareMarker(QString qsShareMarker);

Default Value

""

Remarks

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

Refer to ListShares for more information.

This property is not available at design time.

Data Type

String

ShareCount Property (AzureFile Class)

The number of records in the Share arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetShareCount();

Unicode (Windows)
INT GetShareCount();

int cloudstorage_azurefile_getsharecount(void* lpObj);

int GetShareCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ShareETag
• ShareModifiedTime
• ShareName
• ShareQuota
• ShareSpaceUsed

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

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

Data Type

Integer

ShareETag Property (AzureFile Class)

The ETag of the share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShareETag(int iShareIndex);

Unicode (Windows)
LPWSTR GetShareETag(INT iShareIndex);

char* cloudstorage_azurefile_getshareetag(void* lpObj, int shareindex);

QString GetShareETag(int iShareIndex);

Default Value

""

Remarks

The ETag of the share.

This property reflects the ETag of the share.

The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

String

ShareModifiedTime Property (AzureFile Class)

The last modified time of the share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShareModifiedTime(int iShareIndex);

Unicode (Windows)
LPWSTR GetShareModifiedTime(INT iShareIndex);

char* cloudstorage_azurefile_getsharemodifiedtime(void* lpObj, int shareindex);

QString GetShareModifiedTime(int iShareIndex);

Default Value

""

Remarks

The last modified time of the share.

This property reflects the last modified time of the share, formatted according to RFC 1123.

Note that the share's last modified time is not updated by operations against resources within the share.

The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

String

ShareName Property (AzureFile Class)

The name of the share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShareName(int iShareIndex);

Unicode (Windows)
LPWSTR GetShareName(INT iShareIndex);

char* cloudstorage_azurefile_getsharename(void* lpObj, int shareindex);

QString GetShareName(int iShareIndex);

Default Value

""

Remarks

The name of the share.

This property reflects the name of the share.

The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

String

ShareQuota Property (AzureFile Class)

The share's space quota, in GB.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetShareQuota(int iShareIndex);

Unicode (Windows)
INT GetShareQuota(INT iShareIndex);

int cloudstorage_azurefile_getsharequota(void* lpObj, int shareindex);

int GetShareQuota(int iShareIndex);

Default Value

0

Remarks

The share's space quota, in GB.

This property reflects the space quota, in GB, imposed on the share.

The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

Integer

ShareSpaceUsed Property (AzureFile Class)

The amount of storage space consumed by the share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetShareSpaceUsed(int iShareIndex);

Unicode (Windows)
INT GetShareSpaceUsed(INT iShareIndex);

int cloudstorage_azurefile_getsharespaceused(void* lpObj, int shareindex);

int GetShareSpaceUsed(int iShareIndex);

Default Value

0

Remarks

The amount of storage space consumed by the share.

This property reflects the approximate amount of storage space, in GB, the share is consuming.

The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.

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

Data Type

Integer

SSLAcceptServerCertEncoded Property (AzureFile Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_azurefile_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (AzureFile Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_azurefile_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_azurefile_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getsslcertstorepassword(void* lpObj);
int cloudstorage_azurefile_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

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

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (AzureFile Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_azurefile_getsslcertstoretype(void* lpObj);
int cloudstorage_azurefile_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

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

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getsslcertsubject(void* lpObj);
int cloudstorage_azurefile_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

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

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (AzureFile Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

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

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

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

int cloudstorage_azurefile_getsslprovider(void* lpObj);
int cloudstorage_azurefile_setsslprovider(void* lpObj, int iSSLProvider);

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

Default Value

0

Remarks

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

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (AzureFile Class)

This is the certificate (PEM/Base64 encoded).

Syntax

• C++
• C
• Qt

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

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

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

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

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

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

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

Data Type

Binary String

StartByte Property (AzureFile Class)

The byte offset from which to start 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_azurefile_getstartbyte(void* lpObj);
int cloudstorage_azurefile_setstartbyte(void* lpObj, int64 lStartByte);

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

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file (or stream, when uploading) from which to resume. See UploadFile and DownloadFile for details 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 UploadFile is called. Keep this in mind when resuming interrupted uploads.

This property is not available at design time.

Data Type

Long64

Timeout Property (AzureFile Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_gettimeout(void* lpObj);
int cloudstorage_azurefile_settimeout(void* lpObj, int iTimeout);

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

Default Value

60

Remarks

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

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

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

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

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseSSL Property (AzureFile 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_azurefile_getusessl(void* lpObj);
int cloudstorage_azurefile_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 (AzureFile Class)

Aborts a copy operation.

Syntax

• C++
• C
• Qt

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

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

int cloudstorage_azurefile_abortcopy(void* lpObj, const char* lpszDestFilePath, const char* lpszCopyId);

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

Remarks

This method aborts the copy operation identified by the given CopyId for the destination file at DestFilePath in the share currently selected by Share.

Note that the destination file 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.)

AddMetadata Method (AzureFile 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_azurefile_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 (AzureFile 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_azurefile_addqueryparam(void* lpObj, const char* lpszName, const char* lpszValue);

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

Remarks

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

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

Error Handling (C++)

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

ClearRange Method (AzureFile Class)

Clears a range of bytes from a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ClearRange(const char* lpszFilePath, int64 lFirst, int64 lLast);

Unicode (Windows)
INT ClearRange(LPCWSTR lpszFilePath, LONG64 lFirst, LONG64 lLast);

int cloudstorage_azurefile_clearrange(void* lpObj, const char* lpszFilePath, int64 lFirst, int64 lLast);

int ClearRange(const QString& qsFilePath, qint64 lFirst, qint64 lLast);

Remarks

This method clears the range of bytes from First to Last (inclusive) from the file at FilePath in the share currently selected by Share.

The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file. When this method is called, the server frees any such chunks that are completely covered by the specified range of bytes ([First]-[Last]), and writes 0s to the appropriate portions of any chunks which are not completely covered by that range.

Freed chunks are not included in the results returned by GetRanges.

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 (AzureFile 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_azurefile_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.

CopyFile Method (AzureFile Class)

Copies a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CopyFile(const char* lpszFromFilePath, const char* lpszToFilePath, const char* lpszToShare);

Unicode (Windows)
LPWSTR CopyFile(LPCWSTR lpszFromFilePath, LPCWSTR lpszToFilePath, LPCWSTR lpszToShare);

char* cloudstorage_azurefile_copyfile(void* lpObj, const char* lpszFromFilePath, const char* lpszToFilePath, const char* lpszToShare);

QString CopyFile(const QString& qsFromFilePath, const QString& qsToFilePath, const QString& qsToShare);

Remarks

This method copies the file at FromFilePath (in the share currently selected by Share) to the path ToFilePath in the share ToShare. If this method finishes successfully, it will either return an asynchronous copy operation Id, or an empty string (if the copy has finished already).

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

Any parent folders included in ToFilePath must already exist.

If the destination file already exists, it will be overwritten.

As long as the server doesn't return an error, 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 GetFileInfo method to poll the destination file'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 file to another location within the same share. string copyResult = azurefile.CopyFile("/folder1/important.zip", "/folder2/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 GetFileInfo(). if (!string.IsNullOrEmpty(copyResult)) { do { azurefile.GetFileInfo("/folder2/secrets.zip"); Console.WriteLine("Copy progress: " + azurefile.Config("CopyProgress")); } while (azurefile.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.

CreateFile Method (AzureFile Class)

Initializes a new file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateFile(const char* lpszNewFilePath, int64 lFileLength);

Unicode (Windows)
LPWSTR CreateFile(LPCWSTR lpszNewFilePath, LONG64 lFileLength);

char* cloudstorage_azurefile_createfile(void* lpObj, const char* lpszNewFilePath, int64 lFileLength);

QString CreateFile(const QString& qsNewFilePath, qint64 lFileLength);

Remarks

This method initializes a new file with a given FileLength (in bytes) at the specified NewFilePath in the share currently selected by Share. The path of the newly-initialized file is returned.

Any parent folders included in NewFilePath must already exist.

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.

Note: This method is typically only useful for advanced use-cases. To upload a file, just call UploadFile.

Usage Notes

This method does not upload or otherwise allocate any data, it just creates the file entry and "reserves" storage space for it. After a file has been created with this method, the following methods can be used to manipulate its data:

• The PutRange method can be used to upload ranges of data (up to 4MB at once) to the file.
• The ClearRange method can be used to clear an arbitrary range of data from the file, allowing the server to release the associated storage resources.
• The GetRanges method can be used to obtain a list of all data ranges present in the file.

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.

CreateFolder Method (AzureFile Class)

Creates a new folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* CreateFolder(const char* lpszNewFolderPath);

Unicode (Windows)
LPWSTR CreateFolder(LPCWSTR lpszNewFolderPath);

char* cloudstorage_azurefile_createfolder(void* lpObj, const char* lpszNewFolderPath);

QString CreateFolder(const QString& qsNewFolderPath);

Remarks

This method creates a new folder at the specified NewFolderPath in the share currently selected by Share. The path of the newly-created folder is returned.

Any parent folders included in NewFolderPath must already exist.

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.

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.

CreateShare Method (AzureFile Class)

Creates a new share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int CreateShare();

Unicode (Windows)
INT CreateShare();

int cloudstorage_azurefile_createshare(void* lpObj);

int CreateShare();

Remarks

This method creates a new share using the name specified by the Share property.

If the CreateShareQuota configuration setting is a positive, non-zero integer when this method is called, the share will be created with a space quota of that many GB. A share's space quota may be changed at any time using the SetShareQuota method.

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.

Share Name Rules

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

DeleteFile Method (AzureFile Class)

Deletes a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteFile(const char* lpszFilePath);

Unicode (Windows)
INT DeleteFile(LPCWSTR lpszFilePath);

int cloudstorage_azurefile_deletefile(void* lpObj, const char* lpszFilePath);

int DeleteFile(const QString& qsFilePath);

Remarks

This method deletes the file at the specified FilePath in the share currently selected by Share.

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

DeleteFolder Method (AzureFile Class)

Deletes a folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteFolder(const char* lpszFolderPath);

Unicode (Windows)
INT DeleteFolder(LPCWSTR lpszFolderPath);

int cloudstorage_azurefile_deletefolder(void* lpObj, const char* lpszFolderPath);

int DeleteFolder(const QString& qsFolderPath);

Remarks

This method deletes the folder at the specified FolderPath in the share currently selected by Share.

Only empty folders may be deleted; non-empty folders must be emptied first.

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

DeleteShare Method (AzureFile Class)

Deletes a share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteShare();

Unicode (Windows)
INT DeleteShare();

int cloudstorage_azurefile_deleteshare(void* lpObj);

int DeleteShare();

Remarks

This method deletes the share currently selected by the Share property.

If the currently selected Share has any snapshots associated with it, and the DeleteShareSnapshots configuration setting is disabled (default) when this method is called, the server will return an error. Shares with snapshots can only be deleted after enabling DeleteShareSnapshots.

Note that, according to the Azure File Storage documentation, a share's name cannot be reused until at least 30 seconds after its deletion.

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

DownloadFile Method (AzureFile Class)

Downloads a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DownloadFile(const char* lpszFilePath);

Unicode (Windows)
INT DownloadFile(LPCWSTR lpszFilePath);

int cloudstorage_azurefile_downloadfile(void* lpObj, const char* lpszFilePath);

int DownloadFile(const QString& qsFilePath);

Remarks

This method downloads the file at the specified FilePath in the share currently selected by Share.

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

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

Download Notes

In the simplest use-case, downloading a file looks like this: azurefile.LocalFile = "../MyFile.zip"; azurefile.DownloadFile(azurefile.Resources[0].Path);

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 = "../MyFile.zip"; azurefile.LocalFile = downloadFile; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file azurefile.StartByte = new FileInfo(downloadFile).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

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. azurefile.LocalFile = "../MyFile.zip"; azurefile.EncryptionPassword = "password"; azurefile.DownloadFile(azurefile.Resources[0].Path); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file azurefile.StartByte = new FileInfo(azurefile.Config("DownloadTempFile")).Length; azurefile.DownloadFile(azurefile.Resources[0].Path);

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

GetFileInfo Method (AzureFile Class)

Gets a file's information and metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFileInfo(const char* lpszFilePath);

Unicode (Windows)
INT GetFileInfo(LPCWSTR lpszFilePath);

int cloudstorage_azurefile_getfileinfo(void* lpObj, const char* lpszFilePath);

int GetFileInfo(const QString& qsFilePath);

Remarks

This method gets information and metadata for the file at the specified FilePath in the share currently selected by Share.

Calling this method will fire the ResourceList event, will re-populate the Resource* properties with a single item, and will re-populate the Metadata* properties with any metadata currently associated with the file.

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

GetFolderInfo Method (AzureFile Class)

Gets a folder's information and metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFolderInfo(const char* lpszFolderPath);

Unicode (Windows)
INT GetFolderInfo(LPCWSTR lpszFolderPath);

int cloudstorage_azurefile_getfolderinfo(void* lpObj, const char* lpszFolderPath);

int GetFolderInfo(const QString& qsFolderPath);

Remarks

This method gets information and metadata for the folder at the specified FolderPath in the share currently selected by Share.

FolderPath can be empty string to get information about the root folder of the share.

Calling this method will fire the ResourceList event, will re-populate the Resource* properties with a single item, and will re-populate the Metadata* properties with any metadata currently associated with the folder.

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

Creates a link that provides access to a share or file.

Syntax

• C++
• C
• Qt

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

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

char* cloudstorage_azurefile_getlink(void* lpObj, const char* lpszFilePath, const char* lpszPermissions, const char* lpszStartTime, const char* lpszExpiryTime);

QString GetLink(const QString& qsFilePath, 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 share or file. 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 QueryParam* properties.

If any of the query parameters listed below are present in the QueryParam* 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.

GetRanges Method (AzureFile Class)

Gets the list of allocated data ranges in a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRanges(const char* lpszFilePath);

Unicode (Windows)
INT GetRanges(LPCWSTR lpszFilePath);

int cloudstorage_azurefile_getranges(void* lpObj, const char* lpszFilePath);

int GetRanges(const QString& qsFilePath);

Remarks

This method gets the list of allocated data ranges in the file at the specified FilePath in the share currently selected by Share and populates the Range* properties with the results.

The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file; thus, the size of every range returned by this method will always be a multiple of 512. Chunks that are not currently allocated (either because no data has been written to them, or because they've been freed with ClearRange) will not be returned by 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.)

GetShareInfo Method (AzureFile Class)

Gets a share's information and metadata.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetShareInfo();

Unicode (Windows)
INT GetShareInfo();

int cloudstorage_azurefile_getshareinfo(void* lpObj);

int GetShareInfo();

Remarks

This method gets information and metadata for the share currently selected by the Share property.

Calling this method will fire the ShareList event, will re-populate the Share* properties with a single item, and will re-populate the Metadata* properties with any metadata currently associated with the share.

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

Interrupt the current method.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();

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

ListResources Method (AzureFile Class)

Lists resources in a given folder.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListResources(const char* lpszFolderPath);

Unicode (Windows)
INT ListResources(LPCWSTR lpszFolderPath);

int cloudstorage_azurefile_listresources(void* lpObj, const char* lpszFolderPath);

int ListResources(const QString& qsFolderPath);

Remarks

This method lists the resources in the folder at the specified FolderPath in the share currently selected by Share.

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.

Calling this method will fire the ResourceList event once for each resource, and will also populate the Resource* properties.

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

Note that the server only returns the following resource properties when listing resources (use GetFileInfo or GetFolderInfo to retrieve all properties for a specific resource):

• ResourceName
• ResourcePath (populated by the class automatically)
• ResourceShare (populated by the class automatically)
• ResourceSize
• ResourceType

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

ListShares Method (AzureFile Class)

Lists shares in the file storage account.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListShares();

Unicode (Windows)
INT ListShares();

int cloudstorage_azurefile_listshares(void* lpObj);

int ListShares();

Remarks

This method lists the shares in the file 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.

Calling this method will fire the ShareList event once for each share, and will also populate the Share* properties.

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

Note that the server does not return the shares' ShareSpaceUsed property when listing shares; use GetShareInfo to retrieve all properties for a specific share. // ShareList event handler. azurefile.OnShareList += (s, e) => { Console.WriteLine(e.Name); }; do { azurefile.ListShares(); for (int i = 0; i < azurefile.Shares.Count; i++) { // Process shares here. } } while (!string.IsNullOrEmpty(azurefile.ShareMarker));

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

PutRange Method (AzureFile Class)

Uploads a range of data to a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int PutRange(const char* lpszFilePath, int64 lWriteOffset);

Unicode (Windows)
INT PutRange(LPCWSTR lpszFilePath, LONG64 lWriteOffset);

int cloudstorage_azurefile_putrange(void* lpObj, const char* lpszFilePath, int64 lWriteOffset);

int PutRange(const QString& qsFilePath, qint64 lWriteOffset);

Remarks

This method uploads a range of data to the file at the specified FilePath in the share currently selected by Share. The data to upload cannot be larger than 4MB (4194304 bytes), and is written to the file at the given WriteOffset (specified in bytes).

The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file. However, neither the WriteOffset nor the length of the data to upload need be a multiple of 512. Any portions of a chunk not written to will be populated with 0s.

Note that, according to the Azure File Storage documentation, this operation requires a write lock on the entire file in order to complete successfully.

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

Resets the class to its initial state.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

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

ResizeFile Method (AzureFile Class)

Resizes a file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ResizeFile(const char* lpszFilePath, int64 lNewSize);

Unicode (Windows)
INT ResizeFile(LPCWSTR lpszFilePath, LONG64 lNewSize);

int cloudstorage_azurefile_resizefile(void* lpObj, const char* lpszFilePath, int64 lNewSize);

int ResizeFile(const QString& qsFilePath, qint64 lNewSize);

Remarks

This method resizes the file at the specified FilePath in the share currently selected by Share. NewSize, which is specified in bytes, cannot be negative.

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 (AzureFile 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_azurefile_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.)

SetShareQuota Method (AzureFile Class)

Sets a share's space quota.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetShareQuota(int iQuota);

Unicode (Windows)
INT SetShareQuota(INT iQuota);

int cloudstorage_azurefile_setsharequota(void* lpObj, int iQuota);

int SetShareQuota(int iQuota);

Remarks

This method sets the size, in GB, of the space quota imposed on the share currently selected by the Share property. Quota must be greater than 0.

It is legal to lower a share's quota to a value less than its current space usage. However, doing so will prevent new space from being allocated until either the space usage falls below quota or the quota is raised above the space usage.

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 (AzureFile 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_azurefile_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.)

UpdateMetadata Method (AzureFile Class)

Sets the metadata for a file, folder, or share.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int UpdateMetadata(const char* lpszPath, int iResourceType);

Unicode (Windows)
INT UpdateMetadata(LPCWSTR lpszPath, INT iResourceType);

int cloudstorage_azurefile_updatemetadata(void* lpObj, const char* lpszPath, int iResourceType);

int UpdateMetadata(const QString& qsPath, int iResourceType);

Remarks

This method sets the metadata for a file, folder, or share to the items currently held by the Metadata* properties. The ResourceType parameter indicates the kind of resource the class should prepare the request for; possible values are:

• 0: Set the metadata for the file at the specified Path in the share currently selected by Share.
• 1: Set the metadata for the folder at the specified Path in the share currently selected by Share.
• 2: Set the metadata for the share currently selected by Share (Path is ignored).

Note that it is not possible to do a partial metadata update. That is, all metadata currently associated with the remote entity will be replaced with the metadata sent in the 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.)

UploadFile Method (AzureFile Class)

Uploads a new file resource.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* UploadFile(const char* lpszNewFilePath);

Unicode (Windows)
LPWSTR UploadFile(LPCWSTR lpszNewFilePath);

char* cloudstorage_azurefile_uploadfile(void* lpObj, const char* lpszNewFilePath);

QString UploadFile(const QString& qsNewFilePath);

Remarks

This method uploads a new file resource at the specified NewFilePath in the share currently selected by Share. The path of the newly-created file is returned.

Any parent folders included in NewFilePath must already exist.

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.

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

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

Upload Notes

The UploadFile method is a convenience method that performs a resumable file upload. When called, the class first uses CreateFile to initialize a new file entry on the server; and then it fragments the file data into smaller pieces and calls PutRange multiple times in succession to upload those fragments. The fragment size is fixed at 4MB (this is a server limitation that cannot be changed).

During the upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). If uploading from a stream, be sure to reset its position to where it was the first time the upload was started (typically the beginning). Then call UploadFile again to resume the upload at the specified StartByte offset. azurefile.LocalFile = "../MyFile.zip"; azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. azurefile.UploadFile("MyFile.zip"); MemoryStream uploadStream = new MemoryStream(File.ReadAllBytes("../MyFile.zip")); azurefile.SetUploadStream(uploadStream); azurefile.UploadFile("MyFile.zip"); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte is already populated from the previous upload attempt. //You MUST reset the stream's position to where it was when you first started the upload! uploadStream.Position = 0; azurefile.UploadFile("MyFile.zip");

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.

EndTransfer Event (AzureFile Class)

This event fires when a document finishes transferring.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_ENDTRANSFER 1

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);

class AzureFileEndTransferEventParams {
public:
  int Direction();

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

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

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

Remarks

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

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

Error Event (AzureFile Class)

Fired when information is available about errors during data delivery.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_ERROR 2

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

class AzureFileErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

FragmentComplete Event (AzureFile Class)

Fires after each fragment of a resumable upload is completed.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_FRAGMENTCOMPLETE 3

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

class AzureFileFragmentCompleteEventParams {
public:
  int FragmentNumber();

  int FragmentCount();

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

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

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

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

Remarks

When UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value begins at 1.

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

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

Header Event (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_HEADER 4

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

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

  const QString &Value();

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

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

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

Remarks

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

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

Log Event (AzureFile Class)

This event fires once for each log message.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_LOG 5

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

class AzureFileLogEventParams {
public:
  int LogLevel();

  const QString &Message();

  const QString &LogType();

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

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

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

Remarks

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

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

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

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

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

Message is the log entry.

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

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

Progress Event (AzureFile Class)

Fires during an upload or download to indicate transfer progress.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_PROGRESS 6

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

class AzureFileProgressEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  qint64 TotalBytes();

  int PercentDone();

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

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

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

Remarks

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

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

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

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

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

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

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

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

ResourceList Event (AzureFile Class)

Fires once for each resource returned when listing resources.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireResourceList(AzureFileResourceListEventParams *e);

typedef struct {
  const char *Name;
  const char *Path;
  const char *Share;
  int ResourceType;
  const char *ModifiedTime;
  int64 Size;
  const char *ETag;
  int reserved;
} AzureFileResourceListEventParams;


Unicode (Windows)
virtual INT FireResourceList(AzureFileResourceListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR Path;
  LPCWSTR Share;
  INT ResourceType;
  LPCWSTR ModifiedTime;
  LONG64 Size;
  LPCWSTR ETag;
  INT reserved;
} AzureFileResourceListEventParams;

#define EID_AZUREFILE_RESOURCELIST 7

virtual INT CLOUDSTORAGE_CALL FireResourceList(LPSTR &lpszName, LPSTR &lpszPath, LPSTR &lpszShare, INT &iResourceType, LPSTR &lpszModifiedTime, LONG64 &lSize, LPSTR &lpszETag);

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

  const QString &Path();

  const QString &Share();

  int ResourceType();

  const QString &ModifiedTime();

  qint64 Size();

  const QString &ETag();

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

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

// Or, subclass AzureFile and override this emitter function.
virtual int FireResourceList(AzureFileResourceListEventParams *e) {...}

Remarks

This event fires once for each resource returned when ListResources, GetFileInfo, or GetFolderInfo is called.

Name is the name of the resource.

Path is the full path of the resource (not including the share).

Share is the name of the share the resource resides in.

ResourceType reflects the resource's type. Possible values are:

ModifiedTime is the last modified time of the resource, formatted according to RFC 1123. (Note: this parameter is not populated by calls to ListResources.)

Size is the size of the file. Always 0 for folders.

ETag is the ETag of the resource. (Note: this parameter is not populated by calls to ListResources.)

ShareList Event (AzureFile Class)

Fires once for each share returned when listing shares.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireShareList(AzureFileShareListEventParams *e);

typedef struct {
  const char *Name;
  const char *ModifiedTime;
  const char *ETag;
  int Quota;
  int reserved;
} AzureFileShareListEventParams;


Unicode (Windows)
virtual INT FireShareList(AzureFileShareListEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPCWSTR ModifiedTime;
  LPCWSTR ETag;
  INT Quota;
  INT reserved;
} AzureFileShareListEventParams;

#define EID_AZUREFILE_SHARELIST 8

virtual INT CLOUDSTORAGE_CALL FireShareList(LPSTR &lpszName, LPSTR &lpszModifiedTime, LPSTR &lpszETag, INT &iQuota);

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

  const QString &ModifiedTime();

  const QString &ETag();

  int Quota();

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

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

// Or, subclass AzureFile and override this emitter function.
virtual int FireShareList(AzureFileShareListEventParams *e) {...}

Remarks

This event fires once for each share returned when ListShares or GetShareInfo is called.

Name is the name of the share.

ModifiedTime is the last modified time of the share, formatted according to RFC 1123.

ETag is the ETag of the share.

Quota is the share's space quota, in GB.

SSLServerAuthentication Event (AzureFile Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_SSLSERVERAUTHENTICATION 9

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

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

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

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

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

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

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

Remarks

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

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

SSLStatus Event (AzureFile Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_SSLSTATUS 10

virtual INT CLOUDSTORAGE_CALL FireSSLStatus(LPSTR &lpszMessage);

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

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

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

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

Remarks

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

StartTransfer Event (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_STARTTRANSFER 11

virtual INT CLOUDSTORAGE_CALL FireStartTransfer(INT &iDirection);

class AzureFileStartTransferEventParams {
public:
  int Direction();

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

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

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

Remarks

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

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

Transfer Event (AzureFile Class)

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

Syntax

• C++
• C
• Qt

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

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


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

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

#define EID_AZUREFILE_TRANSFER 12

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

class AzureFileTransferEventParams {
public:
  int Direction();

  qint64 BytesTransferred();

  int PercentDone();

  const QByteArray &Text();

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

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

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

Remarks

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

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

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

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

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

CloudStorageStream Type

Syntax

CloudStorageStream (declared in cloudstorage.h)

Remarks

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

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

bool CanRead() { return true; }

bool CanSeek() { return true; }

bool CanWrite() { return true; }

int64 GetLength() = 0;

void Close() {}

int Flush() { return 0; }

int Read(void* buffer, int count) = 0;

int64 Seek(int64 offset, int seekOrigin) = 0;

int Write(const void* buffer, int count) = 0;

Config Settings (AzureFile Class)

AzureFile Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}