CloudFiles Class

Properties   Methods   Events   Config Settings   Errors  

The CloudFiles class provides an easy way to upload, download, and manage files and folders with multiple service providers.

Syntax

CloudFiles

Remarks

The CloudFiles class provides a single interface that can be used to work with a variety of services. By supporting multiple providers with a single API code may be written once and used to support multiple services. The following providers are currently supported by this class:

  • Amazon S3
  • Azure Blob
  • Azure File
  • Backblaze B2
  • Box.com
  • Digital Ocean Spaces
  • Dropbox
  • Google Cloud Storage
  • Google Drive
  • Hadoop DFS
  • IBM Cloud Object Storage
  • Linode Object Storage
  • Microsoft OneDrive
  • Wasabi

The class supports simple file and folder management as well as encryption. Capabilities include uploading and downloading files, strong encryption support, creating folders, and more.

To begin, first create an account and register your application. Consult the documentation of the individual service provider for instructions on this process.

Authentication

The following providers use OAuth 2.0 for authentication:

  • Box.com
  • Dropbox
  • Google Cloud Storage*
  • Google Drive
  • Microsoft OneDrive

Use the OAuth class included in the toolkit, or any other OAuth implementation to perform authentication and retrieve an authorization string. Once you've obtained an authorization string like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ
Assign this value to the Authorization property before attempting any operations. Consult the service provider documentation for more information about supported scope values and more details on OAuth authentication.

To authenticate with the remaining providers, set the Account* properties shown in the table below:

Provider Relevant properties
Amazon S3 AccountAccessKey and AccountSecretKey
Azure Blob AccountAccount and AccountAccessKey
Azure File AccountAccount and AccountAccessKey
Backblaze B2 AccountApplicationKeyId and AccountApplicationKey
Digital Ocean Spaces AccountAccessKey and AccountSecretKey
Google Cloud Storage* AccountProjectId (if using Authorization for OAuth); or, AccountAccessKey and AccountSecretKey
Hadoop DFS Multiple HTTP authentication schemes are supported; refer to AccountAuthMechanism for more information. AccountHadoopURL must always be set.
IBM Cloud Object Storage AccountAccessKey and AccountSecretKey
Linode Object Storage AccountAccessKey and AccountSecretKey
Wasabi AccountAccessKey and AccountSecretKey

*Google Cloud Storage supports two authentication methods. To authenticate with OAuth 2.0 (preferred) set the Authorization property and the AccountProjectId property. To authenticate with an access and secret key, set the AccountAccessKey and AccountSecretKey properties instead.

Selecting a Provider

To specify the provider simply set ServiceProvider. This tells the class to which service requests will be made.

Listing Files and Folders

ListDirectory lists files and folder the path specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList* properties. cloudfiles.RemoteFile = ""; //Clear filemask cloudfiles.RemotePath = "MyFolder"; cloudfiles.ListDirectory(); for (int i = 0; i < cloudfiles.DirList.Count; i++) { Console.WriteLine(cloudfiles.DirList[i].FileName); Console.WriteLine(cloudfiles.DirList[i].FileSize); Console.WriteLine(cloudfiles.DirList[i].FileTime); Console.WriteLine(cloudfiles.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: component.RemoteFile = "*.txt" component.ListDirectory()

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

Downloading Files

The Download method downloads a specific file.

Set RemoteFile to the name the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

The file will be downloaded to the stream specified (if any) by SetDownloadStream. If a stream is not specified and LocalFile is set the file will be saved to the specified location. If a stream is not specified and LocalFile is not set the file data will be held by ResourceData.

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method. cloudfiles.RemotePath = "My Folder"; cloudfiles.RemoteFile = "MyFile.zip"; cloudfiles.LocalFile = "../MyFile.zip"; cloudfiles.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If the download was interrupted, set StartByte to the appropriate offset before calling this method to resume the download. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially downloaded file cloudfiles.StartByte = new FileInfo(downloadFile).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt. When beginning an encrypted download if LocalFile is set the class will create a temporary file in TempPath to hold the encrypted data until it is complete.

If the download is interrupted DownloadTempFile will be populated with the temporary file holding the partial data. When resuming, 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. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially download temp file cloudfiles.StartByte = new FileInfo(cloudfiles.Config("DownloadTempFile")).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download();

Uploading Files

The Upload method is used to upload files. If SetUploadStream is used to set an upload stream the data to upload is taken from the stream instead.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

To encrypt a file before uploading set EncryptionAlgorithm and EncryptionPassword.

Note: Resuming uploads is not currently supported.

Code Example: //Upload with a relative path cloudfiles.LocalFile = "C:\localfile.txt" cloudfiles.RemoteFile = "remotefile.txt" cloudfiles.Upload() //Upload with an absolute path cloudfiles.LocalFile = "C:\localfile2.txt" cloudfiles.RemoteFile = "/folder/remotefile2.txt" cloudfiles.Upload()

Additional Functionality

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

Property List


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

AccountAccessKeyA storage service provider access key.
AccountAccountA storage service provider account string.
AccountApplicationKeyA storage service provider application key.
AccountApplicationKeyIdA storage service provider application key Id.
AccountAuthMechanismThe HTTP authentication scheme to use (for storage service providers that support multiple).
AccountHadoopURLThe URL of the Hadoop WebHDFS server.
AccountPasswordA storage service provider password.
AccountProjectIdA Google Cloud Platform project Id string.
AccountSecretKeyA storage service provider access key.
AccountUserA storage service provider user name.
AuthorizationOAuth 2.0 Authorization Token.
DirListCountThe number of records in the DirList arrays.
DirListFileNameThis property holds the name of the file or folder.
DirListFileSizeThis property holds the size of the file in bytes.
DirListFileTimeThis property holds the modified date of the file.
DirListIsDirThis property specifies whether the entry is a directory.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the class.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
OverwriteWhether to overwrite the local or remote file.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
ProxyUserThis property contains a username if authentication is to be used for the proxy.
RemoteFileThe name of the remote file.
RemotePathThe current path on the server.
ServiceProviderThe storage service provider.
SSLAcceptServerCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertEncodedThis is the certificate (PEM/Base64 encoded).
SSLCertStoreThis is the name of the certificate store for the client certificate.
SSLCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreTypeThis is the type of certificate store for this certificate.
SSLCertSubjectThis is the subject of the certificate used for client authentication.
SSLProviderThis specifies the SSL/TLS implementation to use.
SSLServerCertEncodedThis is the certificate (PEM/Base64 encoded).
StartByteThe byte offset from which to start download.
TimeoutA timeout for the class.

Method List


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

ConfigSets or retrieves a configuration setting.
DeleteFileRemove a file specified by FileName from the server.
DownloadDownload the specified file.
InterruptInterrupt the current method.
ListDirectoryLists the current directory specified by RemotePath on the server.
MakeDirectoryCreates a directory on the server.
RemoveDirectoryRemove the specified directory.
RenameFileRenames the file.
ResetResets the class to its initial state.
SetDownloadStreamSets the stream to which downloaded data will be written.
SetUploadStreamSets the stream from which data is read when uploading.
UploadUploads the file specified by LocalFile to the server.

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.

DirListFired when a directory entry is received.
EndTransferThis event fires when a document finishes transferring.
ErrorFired when information is available about errors during data delivery.
LogThis event fires once for each log message.
ProgressFires during an upload or download to indicate transfer progress.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusFired when secure connection progress messages are available.
StartTransferThis event fires when a document starts transferring (after the headers).
TransferThis event is fired while a document transfers (delivers document).

Config Settings


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

AllowTransferEventOnlyEnables using just the Transfer event when downloading.
AWSProfileThe name of the AWS CLI profile that the class should use to obtain authentication and region information.
AWSProfileDirThe location of the AWS CLI credentials and config files.
ContentDispositionThe Content-Disposition to send when uploading an file to an S3-like storage provider.
ContentTypeThe Content-Type to send when uploading an file to an S3-like storage provider.
DateFormatThe date format of the file time.
DocsExportFormatThe file format to export Google Docs files as when downloading.
DownloadTempFileThe temporary file used when downloading encrypted data.
DrawingsExportFormatThe file format to export Google Drawings files as when downloading.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
EncryptionPasswordKDFThe KDF algorithm to use during password based encryption and decryption.
FragmentSizeThe fragment size that the class should use when uploading files in multiple fragments.
ListResourcesScopeControls the scope of the results when listing GoogleDrive resources.
NewVersionOnOverwriteWhether to upload new file versions instead of performing true overwrites.
NormalizedFileName[i]The normalized file name.
ProgressAbsoluteWhether the class should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
RegionFor applicable providers, specifies the region to use.
SharedDriveIdThe Id of the Google Drive shared drive to list resources for.
SheetsExportFormatThe file format to export Google Sheets files as when downloading.
SimpleUploadLimitThe threshold above which the class will choose to perform a multipart upload, for applicable storage service providers.
SlidesExportFormatThe file format to export Google Slides files as when downloading.
TempPathThe path to the directory where temporary files are created.
UseVirtualHostingDetermines which URL style S3-like storage service providers should use.
XChildCountThe number of child elements of the current element.
XChildName[i]The name of the child element.
XChildXText[i]The inner text of the child element.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveRetryCountThe number of keep-alive packets to be sent before the remotehost is considered disconnected.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPIWhether or not to use the system security libraries or an internal implementation.

AccountAccessKey Property (CloudFiles Class)

A storage service provider access key.

Syntax

ANSI (Cross Platform)
char* GetAccountAccessKey();
int SetAccountAccessKey(const char* lpszAccountAccessKey); Unicode (Windows) LPWSTR GetAccountAccessKey();
INT SetAccountAccessKey(LPCWSTR lpszAccountAccessKey);
char* cloudstorage_cloudfiles_getaccountaccesskey(void* lpObj);
int cloudstorage_cloudfiles_setaccountaccesskey(void* lpObj, const char* lpszAccountAccessKey);
QString GetAccountAccessKey();
int SetAccountAccessKey(QString qsAccountAccessKey);

Default Value

""

Remarks

A storage service provider access key.

This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

  • cspAmazonS3 (0)
  • cspAzureBlob (6)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9) (only if Authorization and AccountProjectId are not populated)
  • cspAzureFile (11)
  • cspIBMStorage (13)
  • cspLinode (14)

Data Type

String

AccountAccount Property (CloudFiles Class)

A storage service provider account string.

Syntax

ANSI (Cross Platform)
char* GetAccountAccount();
int SetAccountAccount(const char* lpszAccountAccount); Unicode (Windows) LPWSTR GetAccountAccount();
INT SetAccountAccount(LPCWSTR lpszAccountAccount);
char* cloudstorage_cloudfiles_getaccountaccount(void* lpObj);
int cloudstorage_cloudfiles_setaccountaccount(void* lpObj, const char* lpszAccountAccount);
QString GetAccountAccount();
int SetAccountAccount(QString qsAccountAccount);

Default Value

""

Remarks

A storage service provider account string.

This property specifies the account string to use for authentication. It must be populated when using one of these storage service providers:

  • cspAzureBlob (6)
  • cspAzureFile (11)

Data Type

String

AccountApplicationKey Property (CloudFiles Class)

A storage service provider application key.

Syntax

ANSI (Cross Platform)
char* GetAccountApplicationKey();
int SetAccountApplicationKey(const char* lpszAccountApplicationKey); Unicode (Windows) LPWSTR GetAccountApplicationKey();
INT SetAccountApplicationKey(LPCWSTR lpszAccountApplicationKey);
char* cloudstorage_cloudfiles_getaccountapplicationkey(void* lpObj);
int cloudstorage_cloudfiles_setaccountapplicationkey(void* lpObj, const char* lpszAccountApplicationKey);
QString GetAccountApplicationKey();
int SetAccountApplicationKey(QString qsAccountApplicationKey);

Default Value

""

Remarks

A storage service provider application key.

This property specifies the application key to use for authentication. It must be populated when using one of these storage service providers:

  • cspBackblazeB2 (12)

Data Type

String

AccountApplicationKeyId Property (CloudFiles Class)

A storage service provider application key Id.

Syntax

ANSI (Cross Platform)
char* GetAccountApplicationKeyId();
int SetAccountApplicationKeyId(const char* lpszAccountApplicationKeyId); Unicode (Windows) LPWSTR GetAccountApplicationKeyId();
INT SetAccountApplicationKeyId(LPCWSTR lpszAccountApplicationKeyId);
char* cloudstorage_cloudfiles_getaccountapplicationkeyid(void* lpObj);
int cloudstorage_cloudfiles_setaccountapplicationkeyid(void* lpObj, const char* lpszAccountApplicationKeyId);
QString GetAccountApplicationKeyId();
int SetAccountApplicationKeyId(QString qsAccountApplicationKeyId);

Default Value

""

Remarks

A storage service provider application key Id.

This property specifies the application key Id to use for authentication. It must be populated when using one of these storage service providers:

  • cspBackblazeB2 (12)

Data Type

String

AccountAuthMechanism Property (CloudFiles Class)

The HTTP authentication scheme to use (for storage service providers that support multiple).

Syntax

ANSI (Cross Platform)
int GetAccountAuthMechanism();
int SetAccountAuthMechanism(int iAccountAuthMechanism); Unicode (Windows) INT GetAccountAuthMechanism();
INT SetAccountAuthMechanism(INT iAccountAuthMechanism);

Possible Values

CAM_NONE(0), 
CAM_SIMPLE(1),
CAM_BASIC(2),
CAM_NTLM(3),
CAM_NEGOTIATE(4),
CAM_OAUTH(5)
int cloudstorage_cloudfiles_getaccountauthmechanism(void* lpObj);
int cloudstorage_cloudfiles_setaccountauthmechanism(void* lpObj, int iAccountAuthMechanism);
int GetAccountAuthMechanism();
int SetAccountAuthMechanism(int iAccountAuthMechanism);

Default Value

0

Remarks

The HTTP authentication scheme to use (for storage service providers that support multiple).

For storage service providers that support more than one HTTP authentication scheme, this property specifies which should be used. This property is only relevant for the following storage service providers:

  • cspHadoopDFS (10)
(For all other storage service providers, the class determines the correct authentication scheme automatically).

Usage

Possible values for this property are:

camNone (0) (default) No authentication is performed.
camSimple (1) Hadoop pseudo/simple authentication is performed.
camBasic (2) Basic authentication is performed.
camNTLM (3) NTLM authentication is performed.
camNegotiate (4) Negotiate authentication is performed.
camOAuth (5) OAuth authentication is performed.

When set to camSimple (1), the value of the AccountUser property is automatically sent in every request using the user.name query parameter. (Note: This authentication scheme is only valid for the cspHadoopDFS (10) storage service provider.)

When set to camBasic (2), camNTLM (3), or camNegotiate (4), the values held by the AccountUser and AccountPassword properties will be used to perform Basic, NTLM, or Negotiate authentication.

When set to camOAuth (5), the value of the Authorization property is automatically sent in every request using the Authorization HTTP header.

Data Type

Integer

AccountHadoopURL Property (CloudFiles Class)

The URL of the Hadoop WebHDFS server.

Syntax

ANSI (Cross Platform)
char* GetAccountHadoopURL();
int SetAccountHadoopURL(const char* lpszAccountHadoopURL); Unicode (Windows) LPWSTR GetAccountHadoopURL();
INT SetAccountHadoopURL(LPCWSTR lpszAccountHadoopURL);
char* cloudstorage_cloudfiles_getaccounthadoopurl(void* lpObj);
int cloudstorage_cloudfiles_setaccounthadoopurl(void* lpObj, const char* lpszAccountHadoopURL);
QString GetAccountHadoopURL();
int SetAccountHadoopURL(QString qsAccountHadoopURL);

Default Value

""

Remarks

The URL of the Hadoop WebHDFS server.

This property specifies the URL of the Hadoop WebHDFS server to make requests against. It must be set when ServiceProvider is set to cspHadoopDFS (10).

A full WebHDFS URL looks like http[s]://<HOST>:<PORT>/webhdfs/v1. The class will automatically append /webhdfs/v1 when making requests (if necessary).

The class automatically detects whether to secure the connection using SSL/TLS based on whether the value begins with http (not secured) or https (secured).

Data Type

String

AccountPassword Property (CloudFiles Class)

A storage service provider password.

Syntax

ANSI (Cross Platform)
char* GetAccountPassword();
int SetAccountPassword(const char* lpszAccountPassword); Unicode (Windows) LPWSTR GetAccountPassword();
INT SetAccountPassword(LPCWSTR lpszAccountPassword);
char* cloudstorage_cloudfiles_getaccountpassword(void* lpObj);
int cloudstorage_cloudfiles_setaccountpassword(void* lpObj, const char* lpszAccountPassword);
QString GetAccountPassword();
int SetAccountPassword(QString qsAccountPassword);

Default Value

""

Remarks

A storage service provider password.

This property specifies the password to use for authentication. It must be populated when using one of these storage service providers:

Data Type

String

AccountProjectId Property (CloudFiles Class)

A Google Cloud Platform project Id string.

Syntax

ANSI (Cross Platform)
char* GetAccountProjectId();
int SetAccountProjectId(const char* lpszAccountProjectId); Unicode (Windows) LPWSTR GetAccountProjectId();
INT SetAccountProjectId(LPCWSTR lpszAccountProjectId);
char* cloudstorage_cloudfiles_getaccountprojectid(void* lpObj);
int cloudstorage_cloudfiles_setaccountprojectid(void* lpObj, const char* lpszAccountProjectId);
QString GetAccountProjectId();
int SetAccountProjectId(QString qsAccountProjectId);

Default Value

""

Remarks

A Google Cloud Platform project Id string.

This property specifies the Google Cloud Platform project Id string to use for authentication. It must be set when using OAuth 2.0 authentication (i.e., the Authorization property is populated) with one of these storage service providers:

  • cspGoogleStorage (9)

Note that the above providers will fall back to using an AccountAccessKey and AccountSecretKey for authentication if either this property or the Authorization property is empty.

Data Type

String

AccountSecretKey Property (CloudFiles Class)

A storage service provider access key.

Syntax

ANSI (Cross Platform)
char* GetAccountSecretKey();
int SetAccountSecretKey(const char* lpszAccountSecretKey); Unicode (Windows) LPWSTR GetAccountSecretKey();
INT SetAccountSecretKey(LPCWSTR lpszAccountSecretKey);
char* cloudstorage_cloudfiles_getaccountsecretkey(void* lpObj);
int cloudstorage_cloudfiles_setaccountsecretkey(void* lpObj, const char* lpszAccountSecretKey);
QString GetAccountSecretKey();
int SetAccountSecretKey(QString qsAccountSecretKey);

Default Value

""

Remarks

A storage service provider access key.

This property specifies the access key to use for authentication. It must be populated when using one of these storage service providers:

  • cspAmazonS3 (0)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9) (only if Authorization and AccountProjectId are not populated)
  • cspIBMStorage (13)
  • cspLinode (14)

Data Type

String

AccountUser Property (CloudFiles Class)

A storage service provider user name.

Syntax

ANSI (Cross Platform)
char* GetAccountUser();
int SetAccountUser(const char* lpszAccountUser); Unicode (Windows) LPWSTR GetAccountUser();
INT SetAccountUser(LPCWSTR lpszAccountUser);
char* cloudstorage_cloudfiles_getaccountuser(void* lpObj);
int cloudstorage_cloudfiles_setaccountuser(void* lpObj, const char* lpszAccountUser);
QString GetAccountUser();
int SetAccountUser(QString qsAccountUser);

Default Value

""

Remarks

A storage service provider user name.

This property specifies the user name to use for authentication. It must be populated when using one of these storage service providers:

Data Type

String

Authorization Property (CloudFiles Class)

OAuth 2.0 Authorization Token.

Syntax

ANSI (Cross Platform)
char* GetAuthorization();
int SetAuthorization(const char* lpszAuthorization); Unicode (Windows) LPWSTR GetAuthorization();
INT SetAuthorization(LPCWSTR lpszAuthorization);
char* cloudstorage_cloudfiles_getauthorization(void* lpObj);
int cloudstorage_cloudfiles_setauthorization(void* lpObj, const char* lpszAuthorization);
QString GetAuthorization();
int SetAuthorization(QString qsAuthorization);

Default Value

""

Remarks

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

Bearer ACCESS_TOKEN
Assign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Data Type

String

DirListCount Property (CloudFiles Class)

The number of records in the DirList arrays.

Syntax

ANSI (Cross Platform)
int GetDirListCount();

Unicode (Windows)
INT GetDirListCount();
int cloudstorage_cloudfiles_getdirlistcount(void* lpObj);
int GetDirListCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

Data Type

Integer

DirListFileName Property (CloudFiles Class)

This property holds the name of the file or folder.

Syntax

ANSI (Cross Platform)
char* GetDirListFileName(int iEntryIndex);

Unicode (Windows)
LPWSTR GetDirListFileName(INT iEntryIndex);
char* cloudstorage_cloudfiles_getdirlistfilename(void* lpObj, int entryindex);
QString GetDirListFileName(int iEntryIndex);

Default Value

""

Remarks

This property holds the name of the file or folder.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

String

DirListFileSize Property (CloudFiles Class)

This property holds the size of the file in bytes.

Syntax

ANSI (Cross Platform)
int64 GetDirListFileSize(int iEntryIndex);

Unicode (Windows)
LONG64 GetDirListFileSize(INT iEntryIndex);
int64 cloudstorage_cloudfiles_getdirlistfilesize(void* lpObj, int entryindex);
qint64 GetDirListFileSize(int iEntryIndex);

Default Value

0

Remarks

This property holds the size of the file in bytes. This is also applicable to folders for depending on the ServiceProvider.

The table below summarizes the applicability of this value on a per-provider basis:

Service Provider FilesDirectories
cspAmazonS3 (0) X
cspBox (1) X X
cspDropbox (2) X
cspGoogleDrive (3) X
cspOneDrive (4) X X
cspAzureBlob (6) X
cspWasabi (7) X
cspDigitalOcean (8) X
cspGoogleStorage (9) X
cspHadoopDFS (10) X
cspAzureFile (11) X
cspBackblazeB2 (12) X
cspIBMStorage (13) X
cspLinode (14) X

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

Long64

DirListFileTime Property (CloudFiles Class)

This property holds the modified date of the file.

Syntax

ANSI (Cross Platform)
char* GetDirListFileTime(int iEntryIndex);

Unicode (Windows)
LPWSTR GetDirListFileTime(INT iEntryIndex);
char* cloudstorage_cloudfiles_getdirlistfiletime(void* lpObj, int entryindex);
QString GetDirListFileTime(int iEntryIndex);

Default Value

""

Remarks

This property holds the modified date of the file. By default the datetime format used is "yyyy-MM-dd'T'HH:mm:ss". To modify this format set DateFormat.

Note: Modified times are not applicable to directories for the following providers:

  • cspAmazonS3 (0)
  • cspDropbox (2)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9)
  • cspBackblazeB2 (12)
  • cspIBMStorage (13)
  • cspLinode (14)

Additionally, the following providers do not return modified times at all:

  • cspAzureFile (11)

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

String

DirListIsDir Property (CloudFiles Class)

This property specifies whether the entry is a directory.

Syntax

ANSI (Cross Platform)
int GetDirListIsDir(int iEntryIndex);

Unicode (Windows)
BOOL GetDirListIsDir(INT iEntryIndex);
int cloudstorage_cloudfiles_getdirlistisdir(void* lpObj, int entryindex);
bool GetDirListIsDir(int iEntryIndex);

Default Value

FALSE

Remarks

This property specifies whether the entry is a directory. If false the entry is a file.

The EntryIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

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

Data Type

Boolean

EncryptionAlgorithm Property (CloudFiles Class)

The encryption algorithm.

Syntax

ANSI (Cross Platform)
int GetEncryptionAlgorithm();
int SetEncryptionAlgorithm(int iEncryptionAlgorithm); Unicode (Windows) INT GetEncryptionAlgorithm();
INT SetEncryptionAlgorithm(INT iEncryptionAlgorithm);

Possible Values

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_cloudfiles_getencryptionalgorithm(void* lpObj);
int cloudstorage_cloudfiles_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:

Algorithm Key Size
0 (eaAES - default) 256
1 (eaBlowfish) 448
2 (eaCAST) 128
3 (eaDES) 64
4 (eaIDEA) 128
5 (eaRC2) 128
6 (eaRC4) 2048
7 (eaTEA) 128
8 (eaTripleDES) 192
9 (eaTwofish) 256
10 (eaRijndael) 256
11 (eaChaCha) 256
12 (eaXSalsa20) 256

Data Type

Integer

EncryptionPassword Property (CloudFiles Class)

The encryption password.

Syntax

ANSI (Cross Platform)
char* GetEncryptionPassword();
int SetEncryptionPassword(const char* lpszEncryptionPassword); Unicode (Windows) LPWSTR GetEncryptionPassword();
INT SetEncryptionPassword(LPCWSTR lpszEncryptionPassword);
char* cloudstorage_cloudfiles_getencryptionpassword(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect); Unicode (Windows) BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);
int cloudstorage_cloudfiles_getfirewallautodetect(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

This property determines the type of firewall to connect through.

Syntax

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType); Unicode (Windows) INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

Possible Values

FW_NONE(0), 
FW_TUNNEL(1),
FW_SOCKS4(2),
FW_SOCKS5(3),
FW_SOCKS4A(10)
int cloudstorage_cloudfiles_getfirewalltype(void* lpObj);
int cloudstorage_cloudfiles_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:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. FirewallPort is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Data Type

Integer

FirewallHost Property (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost); Unicode (Windows) LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);
char* cloudstorage_cloudfiles_getfirewallhost(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword); Unicode (Windows) LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);
char* cloudstorage_cloudfiles_getfirewallpassword(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort); Unicode (Windows) INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);
int cloudstorage_cloudfiles_getfirewallport(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser); Unicode (Windows) LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);
char* cloudstorage_cloudfiles_getfirewalluser(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

The current status of the class.

Syntax

ANSI (Cross Platform)
int GetIdle();

Unicode (Windows)
BOOL GetIdle();
int cloudstorage_cloudfiles_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 (CloudFiles Class)

The location of the local file.

Syntax

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_cloudfiles_getlocalfile(void* lpObj);
wchar_t* cloudstorage_cloudfiles_getlocalfile_W(void* lpObj); // Windows only
int cloudstorage_cloudfiles_setlocalfile(void* lpObj, const char* lpszLocalFile);
int cloudstorage_cloudfiles_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 Upload, and as the destination file when calling Download.

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

Data Type

String

LocalHost Property (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetLocalHost();
int SetLocalHost(const char* lpszLocalHost); Unicode (Windows) LPWSTR GetLocalHost();
INT SetLocalHost(LPCWSTR lpszLocalHost);
char* cloudstorage_cloudfiles_getlocalhost(void* lpObj);
int cloudstorage_cloudfiles_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

Overwrite Property (CloudFiles Class)

Whether to overwrite the local or remote file.

Syntax

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);
int cloudstorage_cloudfiles_getoverwrite(void* lpObj);
int cloudstorage_cloudfiles_setoverwrite(void* lpObj, int bOverwrite);
bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

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

When calling UploadFile, this property determines if the remote file should be overwritten if it already exists.

Data Type

Boolean

ProxyAuthScheme Property (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme); Unicode (Windows) INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

Possible Values

AUTH_BASIC(0), 
AUTH_DIGEST(1),
AUTH_PROPRIETARY(2),
AUTH_NONE(3),
AUTH_NTLM(4),
AUTH_NEGOTIATE(5)
int cloudstorage_cloudfiles_getproxyauthscheme(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect); Unicode (Windows) BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);
int cloudstorage_cloudfiles_getproxyautodetect(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword); Unicode (Windows) LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);
char* cloudstorage_cloudfiles_getproxypassword(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort); Unicode (Windows) INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);
int cloudstorage_cloudfiles_getproxyport(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer); Unicode (Windows) LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);
char* cloudstorage_cloudfiles_getproxyserver(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL); Unicode (Windows) INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

Possible Values

PS_AUTOMATIC(0), 
PS_ALWAYS(1),
PS_NEVER(2),
PS_TUNNEL(3)
int cloudstorage_cloudfiles_getproxyssl(void* lpObj);
int cloudstorage_cloudfiles_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:

psAutomatic (0)Default setting. If the URL is an https URL, the class will use the psTunnel option. If the URL is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser); Unicode (Windows) LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);
char* cloudstorage_cloudfiles_getproxyuser(void* lpObj);
int cloudstorage_cloudfiles_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

RemoteFile Property (CloudFiles Class)

The name of the remote file.

Syntax

ANSI (Cross Platform)
char* GetRemoteFile();
int SetRemoteFile(const char* lpszRemoteFile); Unicode (Windows) LPWSTR GetRemoteFile();
INT SetRemoteFile(LPCWSTR lpszRemoteFile);
char* cloudstorage_cloudfiles_getremotefile(void* lpObj);
int cloudstorage_cloudfiles_setremotefile(void* lpObj, const char* lpszRemoteFile);
QString GetRemoteFile();
int SetRemoteFile(QString qsRemoteFile);

Default Value

""

Remarks

This property contains the name of the remote file to upload or download. This value is either an absolute or relative path based on RemotePath.

Example (Setting RemoteFile) component.LocalFile = "C:\\test.txt"; component.RemoteFile = "test.txt"; component.Upload(); component.LocalFile = "C:\\test.txt"; component.RemoteFile = "/MyFolder/SubFolder/file.txt"; component.Upload(); Note: This property will also act as a file mask when calling ListDirectory.

Example (Using RemoteFile as a file mask): component.RemoteFile = "*.txt" component.ListDirectory()

The following special characters are supported for pattern matching:

? Any single character.
* Any characters or no characters (e.g., C*t matches Cat, Cot, Coast, Ct).
[,-] A range of characters (e.g., [a-z], [a], [0-9], [0-9,a-d,f,r-z]).
\ The slash is ignored and exact matching is performed on the next character.

If these characters need to be used as a literal in a pattern, then they must be escaped by surrounding them with brackets []. Note: "]" and "-" do not need to be escaped. See below for the escape sequences:

CharacterEscape Sequence
? [?]
* [*]
[ [[]
\ [\]

For example, to match the value [Something].txt, specify the pattern [[]Something].txt.

Data Type

String

RemotePath Property (CloudFiles Class)

The current path on the server.

Syntax

ANSI (Cross Platform)
char* GetRemotePath();
int SetRemotePath(const char* lpszRemotePath); Unicode (Windows) LPWSTR GetRemotePath();
INT SetRemotePath(LPCWSTR lpszRemotePath);
char* cloudstorage_cloudfiles_getremotepath(void* lpObj);
int cloudstorage_cloudfiles_setremotepath(void* lpObj, const char* lpszRemotePath);
QString GetRemotePath();
int SetRemotePath(QString qsRemotePath);

Default Value

""

Remarks

This property shows the current working directory on the server. It can also be used to change the working directory by setting an absolute or relative path.

If the path begins with a "/" it is considered an absolute path.

If the first two characters of the path are ".." this indicates a change to the parent directory.

Example (Changing Directory) component.RemotePath = "/MyFolder/Child"; //absolute component.RemotePath = "GrandChild"; //relative, change to a sub-folder of the current directory component.RemotePath = "../.."; //relative, use ".." to navigate to parent folders

Data Type

String

ServiceProvider Property (CloudFiles Class)

The storage service provider.

Syntax

ANSI (Cross Platform)
int GetServiceProvider();
int SetServiceProvider(int iServiceProvider); Unicode (Windows) INT GetServiceProvider();
INT SetServiceProvider(INT iServiceProvider);

Possible Values

CSP_AMAZON_S3(0), 
CSP_BOX(1),
CSP_DROPBOX(2),
CSP_GOOGLE_DRIVE(3),
CSP_ONE_DRIVE(4),
CSP_AZURE_BLOB(6),
CSP_WASABI(7),
CSP_DIGITAL_OCEAN(8),
CSP_GOOGLE_STORAGE(9),
CSP_HADOOP_DFS(10),
CSP_AZURE_FILE(11),
CSP_BACKBLAZE_B2(12),
CSP_IBMSTORAGE(13),
CSP_LINODE(14)
int cloudstorage_cloudfiles_getserviceprovider(void* lpObj);
int cloudstorage_cloudfiles_setserviceprovider(void* lpObj, int iServiceProvider);
int GetServiceProvider();
int SetServiceProvider(int iServiceProvider);

Default Value

0

Remarks

This property specifies the storage service provider which will be used. It is important to note that the ServiceProvider property must be set before setting any configuration settings through the Config method.

Possible values are:

  • cspAmazonS3 (0) (default): Amazon S3
  • cspBox (1): Box.com
  • cspDropbox (2): Dropbox
  • cspGoogleDrive (3): Google Drive
  • cspOneDrive (4): Microsoft OneDrive
  • cspAzureBlob (6): Azure Blob
  • cspWasabi (7): Wasabi
  • cspDigitalOcean (8): Digital Ocean Spaces
  • cspGoogleStorage (9): Google Cloud Storage
  • cspHadoopDFS (10): Hadoop DFS
  • cspAzureFile (11): Azure File
  • cspBackblazeB2 (12): Backblaze B2
  • cspIBMStorage (13): IBM Cloud Object Storage
  • cspLinode (14): Linode Object Storage

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEncoded Property (CloudFiles Class)

This is the certificate (PEM/Base64 encoded).

Syntax

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_cloudfiles_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

This is the certificate (PEM/Base64 encoded).

Syntax

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_cloudfiles_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

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

Syntax

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_cloudfiles_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int cloudstorage_cloudfiles_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:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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 (CloudFiles 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

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword); Unicode (Windows) LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);
char* cloudstorage_cloudfiles_getsslcertstorepassword(void* lpObj);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

This is the type of certificate store for this certificate.

Syntax

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType); Unicode (Windows) INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

Possible Values

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_cloudfiles_getsslcertstoretype(void* lpObj);
int cloudstorage_cloudfiles_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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user.

Note: This store type is not available in Java.

1 (cstMachine)For Windows, this specifies that the certificate store is a machine store.

Note: This store type is not available in Java.

2 (cstPFXFile)The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates.

Note: This store type is only available in Java.

5 (cstJKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.

Note: this store type is only available in Java.

6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).

Note: This store type is only available in Java and .NET.

22 (cstBCFKSBlob)The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.

Note: This store type is only available in Java and .NET.

23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS#11 interface.

To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN.

Code Example. SSH Authentication with Security Key: certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

SSLCertSubject Property (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject); Unicode (Windows) LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);
char* cloudstorage_cloudfiles_getsslcertsubject(void* lpObj);
int cloudstorage_cloudfiles_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:

FieldMeaning
CNCommon Name. This is commonly a hostname like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

Data Type

String

SSLProvider Property (CloudFiles Class)

This specifies the SSL/TLS implementation to use.

Syntax

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider); Unicode (Windows) INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

Possible Values

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1),
SSLP_INTERNAL(2)
int cloudstorage_cloudfiles_getsslprovider(void* lpObj);
int cloudstorage_cloudfiles_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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.
Additional Notes

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

This is the certificate (PEM/Base64 encoded).

Syntax

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

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);
int cloudstorage_cloudfiles_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 (CloudFiles Class)

The byte offset from which to start download.

Syntax

ANSI (Cross Platform)
int64 GetStartByte();
int SetStartByte(int64 lStartByte); Unicode (Windows) LONG64 GetStartByte();
INT SetStartByte(LONG64 lStartByte);
int64 cloudstorage_cloudfiles_getstartbyte(void* lpObj);
int cloudstorage_cloudfiles_setstartbyte(void* lpObj, int64 lStartByte);
qint64 GetStartByte();
int SetStartByte(qint64 lStartByte);

Default Value

0

Remarks

This property may be set to resume a download. This specifies the offset in the file from which to resume. See Download for details about resuming downloads.

Note: Resuming uploads is not currently supported.

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudFiles Class)

A timeout for the class.

Syntax

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout); Unicode (Windows) INT GetTimeout();
INT SetTimeout(INT iTimeout);
int cloudstorage_cloudfiles_gettimeout(void* lpObj);
int cloudstorage_cloudfiles_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

Config Method (CloudFiles Class)

Sets or retrieves a configuration setting.

Syntax

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

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);
char* cloudstorage_cloudfiles_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.

DeleteFile Method (CloudFiles Class)

Remove a file specified by FileName from the server.

Syntax

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

Unicode (Windows)
INT DeleteFile(LPCWSTR lpszFileName);
int cloudstorage_cloudfiles_deletefile(void* lpObj, const char* lpszFileName);
int DeleteFile(const QString& qsFileName);

Remarks

This method deletes the files specified by the FileName parameter from the server. FileName may be either an absolute path, or a path relative to RemotePath.

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

Download Method (CloudFiles Class)

Download the specified file.

Syntax

ANSI (Cross Platform)
int Download();

Unicode (Windows)
INT Download();
int cloudstorage_cloudfiles_download(void* lpObj);
int Download();

Remarks

This method downloads the specified file. Set RemoteFile to the name the file to download before calling this method. If RemoteFile only specifies a filename it will be downloaded from the path specified by RemotePath. RemoteFile may also be set to an absolute path.

The file will be downloaded to the stream specified (if any) by SetDownloadStream. If a stream is not specified and LocalFile is set the file will be saved to the specified location. If a stream is not specified and LocalFile is not set the file data will be held by ResourceData.

To decrypt an encrypted file set EncryptionAlgorithm and EncryptionPassword before calling this method. cloudfiles.RemotePath = "My Folder"; cloudfiles.RemoteFile = "MyFile.zip"; cloudfiles.LocalFile = "../MyFile.zip"; cloudfiles.Download();

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If the download was interrupted, set StartByte to the appropriate offset before calling this method to resume the download. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially downloaded file cloudfiles.StartByte = new FileInfo(downloadFile).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.Download();

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt. When beginning an encrypted download if LocalFile is set the class will create a temporary file in TempPath to hold the encrypted data until it is complete.

If the download is interrupted DownloadTempFile will be populated with the temporary file holding the partial data. When resuming, 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. cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download(); //The transfer is interrupted and Download() above fails. Later, resume the download: //Get the size of the partially download temp file cloudfiles.StartByte = new FileInfo(cloudfiles.Config("DownloadTempFile")).Length; cloudfiles.RemotePath = myRemoteFolder; cloudfiles.RemoteFile = myRemoteFile; cloudfiles.LocalFile = downloadFile; cloudfiles.EncryptionPassword = "password"; cloudfiles.Download();

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

Interrupt the current method.

Syntax

ANSI (Cross Platform)
int Interrupt();

Unicode (Windows)
INT Interrupt();
int cloudstorage_cloudfiles_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.)

ListDirectory Method (CloudFiles Class)

Lists the current directory specified by RemotePath on the server.

Syntax

ANSI (Cross Platform)
int ListDirectory();

Unicode (Windows)
INT ListDirectory();
int cloudstorage_cloudfiles_listdirectory(void* lpObj);
int ListDirectory();

Remarks

This method is used to list the directory specified by RemotePath.

The directory entries are provided through the DirList event and also via the DirList* properties. cloudfiles.RemoteFile = ""; //Clear filemask cloudfiles.RemotePath = "MyFolder"; cloudfiles.ListDirectory(); for (int i = 0; i < cloudfiles.DirList.Count; i++) { Console.WriteLine(cloudfiles.DirList[i].FileName); Console.WriteLine(cloudfiles.DirList[i].FileSize); Console.WriteLine(cloudfiles.DirList[i].FileTime); Console.WriteLine(cloudfiles.DirList[i].IsDir); }

The RemoteFile property may also be used as a filemask when listing files. For instance: component.RemoteFile = "*.txt" component.ListDirectory()

Note: Since RemoteFile is used as a filemask be sure to clear or reset this value before calling ListDirectory

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

MakeDirectory Method (CloudFiles Class)

Creates a directory on the server.

Syntax

ANSI (Cross Platform)
int MakeDirectory(const char* lpszNewDir);

Unicode (Windows)
INT MakeDirectory(LPCWSTR lpszNewDir);
int cloudstorage_cloudfiles_makedirectory(void* lpObj, const char* lpszNewDir);
int MakeDirectory(const QString& qsNewDir);

Remarks

This method is used to create a directory. The parameter NewDir specifies the name of the directory. NewDir may be either an absolute path, or a path relative to RemotePath.

Note: After creating a directory RemoteFile will be updated with the newly created directory name.

Error Handling (C++)

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

RemoveDirectory Method (CloudFiles Class)

Remove the specified directory.

Syntax

ANSI (Cross Platform)
int RemoveDirectory(const char* lpszDirName);

Unicode (Windows)
INT RemoveDirectory(LPCWSTR lpszDirName);
int cloudstorage_cloudfiles_removedirectory(void* lpObj, const char* lpszDirName);
int RemoveDirectory(const QString& qsDirName);

Remarks

This method removes the directory specified by the DirName parameter. DirName may be either an absolute path, or a path relative to RemotePath.

Note: The directory and all of its contents will be deleted when calling this method. (With the exception of non-root-level directories for the cspAzureFile (11) ServiceProvider; such directories can only be deleted if they are 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.)

RenameFile Method (CloudFiles Class)

Renames the file.

Syntax

ANSI (Cross Platform)
int RenameFile(const char* lpszNewName);

Unicode (Windows)
INT RenameFile(LPCWSTR lpszNewName);
int cloudstorage_cloudfiles_renamefile(void* lpObj, const char* lpszNewName);
int RenameFile(const QString& qsNewName);

Remarks

This method renames an existing file on the server. The NewName parameter specifies the new name of the file. cloudfiles.RemotePath = "/MyFolder"; cloudfiles.RemoteFile = "file.txt"; cloudfiles.RenameFile("newfile.txt");

Note: RenameFile is not supported when ServiceProvider is set to one of the following:

  • cspAmazonS3 (0)
  • cspAzureBlob (6)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9)
  • cspAzureFile (11)
  • cspBackblazeB2 (12)
  • cspIBMStorage (13)
  • cspLinode (14)

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

Resets the class to its initial state.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();
int cloudstorage_cloudfiles_reset(void* lpObj);
int Reset();

Remarks

This method resets the class to its initial state.

Error Handling (C++)

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

SetDownloadStream Method (CloudFiles Class)

Sets the stream to which downloaded data will be written.

Syntax

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

Unicode (Windows)
INT SetDownloadStream(CloudStorageStream* sDownloadStream);
int cloudstorage_cloudfiles_setdownloadstream(void* lpObj, CloudStorageStream* sDownloadStream);
int SetDownloadStream(CloudStorageStream* sDownloadStream);

Remarks

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

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

Error Handling (C++)

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

SetUploadStream Method (CloudFiles Class)

Sets the stream from which data is read when uploading.

Syntax

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

Unicode (Windows)
INT SetUploadStream(CloudStorageStream* sUploadStream);
int cloudstorage_cloudfiles_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.)

Upload Method (CloudFiles Class)

Uploads the file specified by LocalFile to the server.

Syntax

ANSI (Cross Platform)
int Upload();

Unicode (Windows)
INT Upload();
int cloudstorage_cloudfiles_upload(void* lpObj);
int Upload();

Remarks

This method uploads the local file specified by LocalFile to the remote file specified by RemoteFile. If SetUploadStream is used to set an upload stream the data to upload is taken from the stream instead.

RemoteFile should be set to either a relative or absolute path. If RemoteFile is not an absolute path it will be uploaded relative to RemotePath.

To encrypt a file before uploading set EncryptionAlgorithm and EncryptionPassword.

Note: Resuming uploads is not currently supported.

Code Example: //Upload with a relative path cloudfiles.LocalFile = "C:\localfile.txt" cloudfiles.RemoteFile = "remotefile.txt" cloudfiles.Upload() //Upload with an absolute path cloudfiles.LocalFile = "C:\localfile2.txt" cloudfiles.RemoteFile = "/folder/remotefile2.txt" cloudfiles.Upload()

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

DirList Event (CloudFiles Class)

Fired when a directory entry is received.

Syntax

ANSI (Cross Platform)
virtual int FireDirList(CloudFilesDirListEventParams *e);
typedef struct {
const char *FileName;
int IsDir;
int64 FileSize;
const char *FileTime; int reserved; } CloudFilesDirListEventParams;
Unicode (Windows) virtual INT FireDirList(CloudFilesDirListEventParams *e);
typedef struct {
LPCWSTR FileName;
BOOL IsDir;
LONG64 FileSize;
LPCWSTR FileTime; INT reserved; } CloudFilesDirListEventParams;
#define EID_CLOUDFILES_DIRLIST 1

virtual INT CLOUDSTORAGE_CALL FireDirList(LPSTR &lpszFileName, BOOL &bIsDir, LONG64 &lFileSize, LPSTR &lpszFileTime);
class CloudFilesDirListEventParams {
public:
  const QString &FileName();

  bool IsDir();

  qint64 FileSize();

  const QString &FileTime();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void DirList(CloudFilesDirListEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireDirList(CloudFilesDirListEventParams *e) {...}

Remarks

This event fires once for each entry returned when ListDirectory is called.

FileName holds the name of the file or folder.

IsDir is true for directories and false for files.

FileSize is the size of the file in bytes. For some providers this also applies directories and will return the size of all files and folders within the directory.

The table below summarizes the applicability of this value on a per-provider basis:

Service Provider FilesDirectories
cspAmazonS3 (0) X
cspBox (1) X X
cspDropbox (2) X
cspGoogleDrive (3) X
cspOneDrive (4) X X
cspAzureBlob (6) X
cspWasabi (7) X
cspDigitalOcean (8) X
cspGoogleStorage (9) X
cspHadoopDFS (10) X
cspAzureFile (11) X
cspBackblazeB2 (12) X
cspIBMStorage (13) X
cspLinode (14) X

FileTime is the modified date of the file. By default the datetime format used is "yyyy-MM-dd'T'HH:mm:ss". To modify this format set DateFormat.

Note: Modified times are not applicable to directories for the following providers:

  • cspAmazonS3 (0)
  • cspDropbox (2)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9)
  • cspBackblazeB2 (12)
  • cspIBMStorage (13)
  • cspLinode (14)

Additionally, the following providers do not return modified times at all:

  • cspAzureFile (11)

EndTransfer Event (CloudFiles Class)

This event fires when a document finishes transferring.

Syntax

ANSI (Cross Platform)
virtual int FireEndTransfer(CloudFilesEndTransferEventParams *e);
typedef struct {
int Direction; int reserved; } CloudFilesEndTransferEventParams;
Unicode (Windows) virtual INT FireEndTransfer(CloudFilesEndTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } CloudFilesEndTransferEventParams;
#define EID_CLOUDFILES_ENDTRANSFER 2

virtual INT CLOUDSTORAGE_CALL FireEndTransfer(INT &iDirection);
class CloudFilesEndTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void EndTransfer(CloudFilesEndTransferEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireEndTransfer(CloudFilesEndTransferEventParams *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 (CloudFiles Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(CloudFilesErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } CloudFilesErrorEventParams;
Unicode (Windows) virtual INT FireError(CloudFilesErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } CloudFilesErrorEventParams;
#define EID_CLOUDFILES_ERROR 3

virtual INT CLOUDSTORAGE_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class CloudFilesErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void Error(CloudFilesErrorEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireError(CloudFilesErrorEventParams *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.

Log Event (CloudFiles Class)

This event fires once for each log message.

Syntax

ANSI (Cross Platform)
virtual int FireLog(CloudFilesLogEventParams *e);
typedef struct {
int LogLevel;
const char *Message;
const char *LogType; int reserved; } CloudFilesLogEventParams;
Unicode (Windows) virtual INT FireLog(CloudFilesLogEventParams *e);
typedef struct {
INT LogLevel;
LPCWSTR Message;
LPCWSTR LogType; INT reserved; } CloudFilesLogEventParams;
#define EID_CLOUDFILES_LOG 4

virtual INT CLOUDSTORAGE_CALL FireLog(INT &iLogLevel, LPSTR &lpszMessage, LPSTR &lpszLogType);
class CloudFilesLogEventParams {
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(CloudFilesLogEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireLog(CloudFilesLogEventParams *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:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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

Fires during an upload or download to indicate transfer progress.

Syntax

ANSI (Cross Platform)
virtual int FireProgress(CloudFilesProgressEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int64 TotalBytes;
int PercentDone; int reserved; } CloudFilesProgressEventParams;
Unicode (Windows) virtual INT FireProgress(CloudFilesProgressEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
LONG64 TotalBytes;
INT PercentDone; INT reserved; } CloudFilesProgressEventParams;
#define EID_CLOUDFILES_PROGRESS 5

virtual INT CLOUDSTORAGE_CALL FireProgress(INT &iDirection, LONG64 &lBytesTransferred, LONG64 &lTotalBytes, INT &iPercentDone);
class CloudFilesProgressEventParams {
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(CloudFilesProgressEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireProgress(CloudFilesProgressEventParams *e) {...}

Remarks

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

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

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

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

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

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

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

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

SSLServerAuthentication Event (CloudFiles Class)

Fired after the server presents its certificate to the client.

Syntax

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(CloudFilesSSLServerAuthenticationEventParams *e);
typedef struct {
const char *CertEncoded; int lenCertEncoded;
const char *CertSubject;
const char *CertIssuer;
const char *Status;
int Accept; int reserved; } CloudFilesSSLServerAuthenticationEventParams;
Unicode (Windows) virtual INT FireSSLServerAuthentication(CloudFilesSSLServerAuthenticationEventParams *e);
typedef struct {
LPCSTR CertEncoded; INT lenCertEncoded;
LPCWSTR CertSubject;
LPCWSTR CertIssuer;
LPCWSTR Status;
BOOL Accept; INT reserved; } CloudFilesSSLServerAuthenticationEventParams;
#define EID_CLOUDFILES_SSLSERVERAUTHENTICATION 6

virtual INT CLOUDSTORAGE_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);
class CloudFilesSSLServerAuthenticationEventParams {
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(CloudFilesSSLServerAuthenticationEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireSSLServerAuthentication(CloudFilesSSLServerAuthenticationEventParams *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 (CloudFiles Class)

Fired when secure connection progress messages are available.

Syntax

ANSI (Cross Platform)
virtual int FireSSLStatus(CloudFilesSSLStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } CloudFilesSSLStatusEventParams;
Unicode (Windows) virtual INT FireSSLStatus(CloudFilesSSLStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } CloudFilesSSLStatusEventParams;
#define EID_CLOUDFILES_SSLSTATUS 7

virtual INT CLOUDSTORAGE_CALL FireSSLStatus(LPSTR &lpszMessage);
class CloudFilesSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void SSLStatus(CloudFilesSSLStatusEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireSSLStatus(CloudFilesSSLStatusEventParams *e) {...}

Remarks

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

StartTransfer Event (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireStartTransfer(CloudFilesStartTransferEventParams *e);
typedef struct {
int Direction; int reserved; } CloudFilesStartTransferEventParams;
Unicode (Windows) virtual INT FireStartTransfer(CloudFilesStartTransferEventParams *e);
typedef struct {
INT Direction; INT reserved; } CloudFilesStartTransferEventParams;
#define EID_CLOUDFILES_STARTTRANSFER 8

virtual INT CLOUDSTORAGE_CALL FireStartTransfer(INT &iDirection);
class CloudFilesStartTransferEventParams {
public:
  int Direction();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};
// To handle, connect one or more slots to this signal. void StartTransfer(CloudFilesStartTransferEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireStartTransfer(CloudFilesStartTransferEventParams *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 (CloudFiles Class)

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

Syntax

ANSI (Cross Platform)
virtual int FireTransfer(CloudFilesTransferEventParams *e);
typedef struct {
int Direction;
int64 BytesTransferred;
int PercentDone;
const char *Text; int lenText; int reserved; } CloudFilesTransferEventParams;
Unicode (Windows) virtual INT FireTransfer(CloudFilesTransferEventParams *e);
typedef struct {
INT Direction;
LONG64 BytesTransferred;
INT PercentDone;
LPCSTR Text; INT lenText; INT reserved; } CloudFilesTransferEventParams;
#define EID_CLOUDFILES_TRANSFER 9

virtual INT CLOUDSTORAGE_CALL FireTransfer(INT &iDirection, LONG64 &lBytesTransferred, INT &iPercentDone, LPSTR &lpText, INT &lenText);
class CloudFilesTransferEventParams {
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(CloudFilesTransferEventParams *e);
// Or, subclass CloudFiles and override this emitter function. virtual int FireTransfer(CloudFilesTransferEventParams *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 CloudFiles 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 CloudFiles 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.

Properties

CanRead Whether the stream supports reading.

bool CanRead() { return true; }
CanSeek Whether the stream supports seeking.

bool CanSeek() { return true; }
CanWrite Whether the stream supports writing.

bool CanWrite() { return true; }
Length Gets the length of the stream, in bytes.

int64 GetLength() = 0;

Methods

Close Closes the stream, releasing all resources currently allocated for it.

void Close() {}

This method is called automatically when a CloudStorageStream object is deleted.

Flush Forces all data held by the stream's buffers to be written out to storage.

int Flush() { return 0; }

Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0.

Read Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.

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

Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream.

Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed.

Seek Sets the current position within the stream based on a particular point of origin.

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

Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:

  • 0: Seek from beginning.
  • 1: Seek from current position.
  • 2: Seek from end.

Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged.

Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported.

Write Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.

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

Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream.

Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (CloudFiles Class)

The class accepts one or more of the following configuration settings. Configuration 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.

CloudFiles Config Settings

AllowTransferEventOnly:   Enables using just the Transfer event when downloading.

When set to "True", you won't need to set LocalFile or call SetDownloadStream before downloading a file. This allows you to use just the Transfer event to capture incoming data.

AWSProfile:   The name of the AWS CLI profile that the class should use to obtain authentication and region information.

This setting, if non-empty, must contain the name of the AWS CLI profile whose authentication and (optionally) region information the class should use to communicate with the server. To use the default profile, set this setting to default. Refer to the following pages of the AWS CLI documentation for more information about AWS profiles, and the credentials and config files used to store them:

The class supports key-based credential profiles; i.e., those which include the aws_access_key_id, aws_secret_access_key, and (optionally) aws_session_token elements. Role-based profiles are not supported at this time.

In addition to the authentication-related elements mentioned above, the class also supports the region element, if it is present in the specified profile.

The class searches for the specified profile's information in the credentials and config files. The AWSProfileDir setting can be used to configure the directory where the class looks for these files. If the aforementioned files do not exist, or the specified profile cannot be found or is missing information, an error will occur.

Note: This setting is applicable only when ServiceProvider is set to one of the following:

  • cspAmazonS3 (0)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9)
  • cspIBMStorage (13)
  • cspLinode (14)

AWSProfileDir:   The location of the AWS CLI credentials and config files.

This setting specifies the directory that the class should check when attempting to locate the AWS CLI credentials and config files. This setting is only used if the AWSProfile setting is non-empty.

By default, this setting is empty, which will cause the class to check the default location used by the AWS CLI: an .aws directory in the current user's home directory; i.e., %UserProfile%\.aws (Windows) or ~/.aws (Linux/macOS).

Note: This setting is applicable only when ServiceProvider is set to one of the following:

  • cspAmazonS3 (0)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9)
  • cspIBMStorage (13)
  • cspLinode (14)

ContentDisposition:   The Content-Disposition to send when uploading an file to an S3-like storage provider.

This setting specifies the value that should be sent for the Content-Disposition header when uploading a file.

Note: This setting is applicable only when ServiceProvider is set to one of the following:

  • cspAmazonS3 (0)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9)
  • cspIBMStorage (13)
  • cspLinode (14)

ContentType:   The Content-Type to send when uploading an file to an S3-like storage provider.

This setting specifies the value that should be sent for the Content-Type header when uploading a file.

Note: This setting is applicable only when ServiceProvider is set to one of the following:

  • cspAmazonS3 (0)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspGoogleStorage (9)
  • cspIBMStorage (13)
  • cspLinode (14)

DateFormat:   The date format of the file time.

This setting specifies the format of the datetime used when reporting the file's modified date. The default value is "yyyy-MM-dd'T'HH:mm:ss" and the server time will be localized.

If this setting is set to empty string the exact value sent by the server will be returned.

DocsExportFormat:   The file format to export Google Docs files as when downloading.

This setting specifies what file format to export Google Docs as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

  • docx (default) - application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • epub - application/epub+zip
  • htm or html - text/html
  • odt - application/vnd.oasis.opendocument.text
  • pdf - application/pdf
  • rtf - application/rtf
  • txt - text/plain
  • zip - application/zip
You may also specify a string like [extension],[MIME type] instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).

DownloadTempFile:   The temporary file used when downloading encrypted data.

This setting specifies the temporary file used when downloading encrypted data.

When downloading encrypted data with LocalFile set, the class will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to LocalFile.

If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See DownloadFile for details.

DrawingsExportFormat:   The file format to export Google Drawings files as when downloading.

This setting specifies what file format to export Google Drawings as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

  • jpg or jpeg - image/jpeg
  • pdf - application/pdf
  • png (default) - image/png
  • svg - image/svg+xml
You may also specify a string like [extension],[MIME type] instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).

EncryptionIV:   The initialization vector to be used for encryption/decryption.

When encrypting or decrypting a file, this setting may be set to specify the initialization vector. Normally the class will derive this value automatically from EncryptionPassword.

This setting accepts a hex encoded value.

EncryptionKey:   The key to use during encryption/decryption.

When encrypting or decrypting a file, this setting may be set to specify the key to use. Normally the class will derive this value automatically from EncryptionPassword.

This setting accepts a hex encoded value.

EncryptionPasswordKDF:   The KDF algorithm to use during password based encryption and decryption.

This setting specified the Key Derivation Function (KDF) used to derive a key from the specified EncryptionPassword. Possible values are:

  • 0 (default) - PBKDF1
  • 1 - PBKDF2
Note: PBKDF1 is not FIPS compliant. When operating in FIPS mode PBKDF2 should be used.

FragmentSize:   The fragment size that the class should use when uploading files in multiple fragments.

The class will sometimes choose to upload files in multiple fragments, depending on the size of the file, and whether the currently-selected ServiceProvider's API includes native support for resumable uploads. In such cases, this setting specifies the fragment size, in bytes, that the class should use.

This setting's default and minimum values vary by ServiceProvider; its maximum value is 2147483647 (2GB). Refer to the configuration settings documentation for each individual storage service provider class for more information.

Note that this setting cannot be changed when ServiceProvider is set to one of the following:

  • cspBox (1)
  • cspAzureFile (11)

ListResourcesScope:   Controls the scope of the results when listing GoogleDrive resources.

When the ServiceProvider property is set to cspGoogleDrive (3), this setting controls the scope of the results when listing resources. Possible values are:

0 - User (default) Items in the user's "My Drive" and "Shared with me" collections.
1 - Domain Items shared to the users domain.
2 - Shared Drive Items within the shared drive specified by the SharedDriveId configuration setting.
3 - All Drives Items in the user's "My Drive" and "Shared with me" collections, as well as all items in all shared drives that the user is a member of.
NewVersionOnOverwrite:   Whether to upload new file versions instead of performing true overwrites.

When the Overwrite property is enabled, and the Upload method is called, the class will normally perform a true overwrite if the destination file already exists (i.e., it will delete the old file before uploading the new one). For service providers that support it, this setting can be enabled to have the class simply upload a new file version instead of doing a true overwrite.

By default, this setting is disabled. It is only applicable when the ServiceProvider property is set to one of the following:

  • cspBox (1)

NormalizedFileName[i]:   The normalized file name.

When using Google Drive as your service provider, any Google Apps files (Docs, Slides, Sheets, etc) are exported to the file formats specified by the *ExportFormat configuration settings when you call Download. After calling ListDirectory, you can query this configuration setting to get the normalized filename for any entry in DirList; for example:

cloudfiles1.RemotePath = "folder1/folder2/"; cloudfiles1.ListDirectory(); for (int i = 0; i < cloudfiles1.DirList.Count; i++) { CFDirEntry entry = cloudfiles1.DirList[i]; cloudfiles1.RemoteFile = entry.FileName; cloudfiles1.LocalFile = "C:\\Test\\" + cloudfiles1.Config("NormalizedFileName[" + i + "]"); cloudfiles1.Download(); }

For Google Apps files, the normalized file name is the name of the file, plus the appropriate extension (if not already present) based on which export formats were set when ListDirectory was last called. For other files, the normalized file name is the same as the file name reported in the DirList entry.

If you change one of the *ExportFormat configuration settings, you'll need to call ListDirectory again to refresh the values returned by this setting.

Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).

ProgressAbsolute:   Whether the class should track transfer progress absolutely.

This setting controls whether the class tracks upload and download progress absolutely or relatively, with regards to the values reported via the Progress event when an interrupted transfer is resumed.

If this setting is enabled (default), then when a transfer is interrupted and later resumed, the values reported by the Progress event will account for the data that was successfully transferred before the interruption.

If this setting is disabled, then the class will treat resumed transfers as "new" transfers, and the values reported by the Progress event will start at 0 rather than from the number of bytes already transferred.

Refer to the Progress event for more information.

ProgressStep:   How often the progress event should be fired, in terms of percentage.

This setting controls how often the class will fire the Progress event during an upload or download, in terms of percentage. Valid values are 0 to 99, inclusive.

The default value, 1, will cause the Progress event to fire each time the event's PercentDone parameter value increases by one percent. Setting this setting to 0 will cause the Progress event to fire every time data is transferred.

Note that the Progress event will always fire once at the beginning and end of a transfer, regardless of this setting's value. Also, if PercentDone cannot be calculated for a particular transfer (e.g., for downloads that use chunked transfer encoding), then the class will behave as if this setting were 0 for the duration of the transfer.

RawRequest:   Returns the data that was sent to the server.

This setting may be queried after calling any method that sends data to the server to obtain the request data that was transmitted. Such data may be useful for troubleshooting purposes.

RawResponse:   Returns the data that was received from the server.

This setting may be queried after calling any method that sends data to the server to obtain the response data that was received. Such data may be useful for troubleshooting purposes.

Region:   For applicable providers, specifies the region to use.

This setting specifies the region to use, and is applicable when ServiceProvider is set to one of the following:

  • cspAmazonS3 (0) - Refer to the AmazonS3 class's Region property for more information.
  • cspWasabi (7) - Refer to the Wasabi class's Region property for more information.
  • cspDigitalOcean (8) - Refer to the DigitalOcean class's Region property for more information.
  • cspGoogleStorage (9) - Refer to the GoogleStorage class's Region property for more information.
  • cspIBMStorage (13) - Refer to the IBMStorage class's Region property for more information.
  • cspLinode (14) - Refer to the Linode class's Region property for more information.
SharedDriveId:   The Id of the Google Drive shared drive to list resources for.

When the ServiceProvider property is set to cspGoogleDrive (3), and the ListResourcesScope setting is set to 2 (Shared Drive), this setting must be set to the Id of a shared drive before attempting to list resources.

SheetsExportFormat:   The file format to export Google Sheets files as when downloading.

This setting specifies what file format to export Google Sheets as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

  • csv - text/csv
  • ods - application/vnd.oasis.opendocument.spreadsheet
  • pdf - application/pdf
  • tsv - text/tab-separated-values
  • xlsx (default) - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  • zip - application/zip
You may also specify a string like [extension],[MIME type] instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).

SimpleUploadLimit:   The threshold above which the class will choose to perform a multipart upload, for applicable storage service providers.

This setting specifies the threshold, in bytes, above which the class will choose to perform a multipart upload rather than uploading everything in one request. It is only applicable when ServiceProvider is set to one of the following:

  • cspAmazonS3 (0)
  • cspAzureBlob (6)
  • cspWasabi (7)
  • cspDigitalOcean (8)
  • cspBackblazeB2 (12)
  • cspIBMStorage (13)
  • cspLinode (14)

For all other providers, the limit is either defined by the server, or the service's API includes native support for resumable uploads.

SlidesExportFormat:   The file format to export Google Slides files as when downloading.

This setting specifies what file format to export Google Slides as when downloading; it takes a file extension, which will be applied to the downloaded filename if necessary. Valid values (and their associated MIME types) are:

  • odp - application/vnd.oasis.opendocument.presentation
  • pdf - application/pdf
  • pptx (default) - application/vnd.openxmlformats-officedocument.presentationml.presentation
  • txt - text/plain
You may also specify a string like [extension],[MIME type] instead of one of the file extensions above if you wish to customize the MIME type to export the file as and/or the file extension to apply to the downloaded file.

Note that this configuration setting is only valid when the ServiceProvider property is set to cspGoogleDrive (3).

TempPath:   The path to the directory where temporary files are created.

This setting specifies the path where temporary files are created when downloading encrypted files. If not specified, the system's temporary directory is used. Refer to DownloadTempFile and DownloadFile for more information.

UseVirtualHosting:   Determines which URL style S3-like storage service providers should use.

This setting determines whether S3-like storage service providers should use path-style or hosted-style URLs when making requests. It is applicable only when ServiceProvider is set to one of the following:

XChildCount:   The number of child elements of the current element.

The number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to (XChildCount - 1).

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XChildName[i]:   The name of the child element.

Provides the name of the i'th child element of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XChildXText[i]:   The inner text of the child element.

Provides the inner text of the i'th child element of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XElement:   The name of the current element.

Provides the name of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XParent:   The parent of the current element.

Provides the parent of the current element.

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XPath:   Provides a way to point to a specific element in the returned XML or JSON response.

The XPath setting allows you to point to specific elements in the XML or JSON response.

When XPath is set to a valid path, XElement points to the name of the element, with XText, XParent, XSubTree, XChildCount, XChildName[i], and XChildXText[i] providing other properties of the element.

XPath Syntax

XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the / character, for example: /A/B/C/D. An XPath can be absolute (i.e., it starts with /), or it can be relative to the current XPath location.

The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string:

Accessor Description
name The first element with a particular name. Can be *.
[i] The i-th element.
name[i] The i-th element with a particular name.
[last()] The last element.
[last()-i] The element i before the last element.
name[@attrname="attrvalue"]The first element with a particular name that contains the specified attribute-value pair.

Supports single and double quotes. (XML Only)

. The current element.
.. The parent element.
Note: XPath indices are 1-based.

XPath Examples

Assuming the following XML response:

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

Or, alternatively, the following JSON response:

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

Here are some examples of valid XPaths:

DescriptionXML XPath JSON XPath
Document root / /json
Specific element /firstlevel/one /json/firstlevel/one
i-th child /firstlevel/two/item[2]/json/firstlevel/two/[2]

This is not an exhaustive list by any means, but should provide a general idea of the possibilities.

XSubTree:   A snapshot of the current element in the document.

Provides the entirety of the current element (including its sub-elements).

The current element is specified via the XPath configuration setting. This configuration setting is read-only.

XText:   The text of the current element.

Provides the inner text of the current element.

The current element is specified in the XPath configuration setting. This configuration setting is read-only.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If true, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. If false, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is false.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the Log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

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

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPassword:   A password if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusCode:   The status code of the last response from the server.

This configuration setting contains the result code of the last response from the server.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UseProxyAutoConfigURL:   Whether to use a Proxy auto-config file when attempting a connection.

This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to True.

When True (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveRetryCount:   The number of keep-alive packets to be sent before the remotehost is considered disconnected.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the number of times that the keep-alive packets will be sent before the remote host is considered disconnected. The system default if this value is not specified here is 9.

Note: This configuration setting is only available in the Unix platform. It is not supported in masOS or FreeBSD.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The LocalHost setting 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 setting 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).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before MaxLineLength bytes are received, the DataIn event is fired with the EOL parameter set to True, and the buffer is reset.

If no EOL is found, and MaxLineLength bytes are accumulated in the buffer, the DataIn event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When SSLProvider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the SSLStatus event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if SSLProvider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the SSLStatus event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when SSLProvider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when SSLProvider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when SSLProvider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30) [Platform Only]
SSL2 12 (Hex 0C) [Platform Only]

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.

In editions which are designed to run on Windows SSLProvider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnabledProtocols: SSL2 and SSL3 Notes:

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is true by default, but can be set to false to disable the extension.

This setting is only applicable when SSLProvider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the SSLServerAuthentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the SSLServerAuthentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the SSLServerAuthentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when SSLProvider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

This functionality is currently not available when the provider is OpenSSL.

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when SSLProvider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and SSLProvider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to true, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (CloudFiles Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

Common Errors

600   A server error occurred, and/or the class was unable to process the server's response. Please refer to the error message for more information.
601   An unsupported operation or action was attempted.
602   The RawRequest or RawResponse configuration setting was queried without first setting the TransferredRequest configuration setting to ON.
603   The login credentials specified were invalid. Please refer to the error message for more information.
604   An invalid remote resource identifier (i.e., a name, path, Id, etc.) was specified.
605   An invalid index was specified.
606   An upload was aborted by the user before it could finish.
607   The specified resource is a folder and cannot be downloaded.
608   A download failed because the specified LocalFile already exists and Overwrite is false.
609   The class could not resume a download or upload. Please refer to the error message for more information.
610   An encrypted download could not be resumed because the DownloadTempFile configuration setting is not set.
611   An exception occurred while working with the specified LocalFile (or the current value of LocalFile is invalid). Please refer to the error message for more information.
612   An exception occurred while working with the specified upload or download stream. Please refer to the error message for more information.

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in URL
153   Specified URLScheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open AttachedFile.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100   You cannot change the RemotePort at this time. A connection is in progress.
101   You cannot change the RemoteHost (Server) at this time. A connection is in progress.
102   The RemoteHost address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the LocalPort at this time. A connection is in progress.
107   You cannot change the LocalHost at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   RemotePort cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).