S3 Class

Properties   Methods   Events   Configuration Settings   Errors  

The S3 class provides an easy-to-use interface for Amazon S3 and other S3-compatible services.

Syntax

S3

Remarks

The S3 class allows you to access Amazon's Simple Storage Service (S3), as well as other S3-compatible services, in a secure manner using TLS/SSL. S3-like services allow you to store arbitrary data objects in various buckets, and access them from anywhere with an internet connection.

A brief synopsis follows, but please refer to Amazon's S3 documentation for more information about the general capabilities of S3.

S3 supports the following providers:

• Amazon S3
• Backblaze B2
• Digital Ocean Spaces
• Google Cloud Storage
• IBM Cloud Object Storage
• Linode Object Storage
• Oracle Cloud Object Storage
• Wasabi

There is also a "custom provider" option, which allows you to interact with any S3-compatible API by specifying its base URL.

Getting Started

To begin, use the ServiceProvider property to select the S3 service provider to use. Then, use the AccessKey and SecretKey properties to specify the access key and secret key that the class should use to sign requests. These keys can be obtained after signing up for an account with the selected service provider.

Working with Buckets

S3 services store objects in various buckets. The following methods can be used to interact with the buckets in an S3 account:

• Creating and deleting buckets: CreateBucket and DeleteBucket
• Checking whether a bucket exists, and its location: BucketExists and GetBucketLocation
• Listing buckets: ListBuckets
• Updating a bucket's canned ACL: UpdateBucketACL

Working with Objects

Once the desired buckets are ready, the following methods can be used to interact with objects:

• Creating, downloading, and deleting objects: CreateObject, GetObject, DeleteObject
• Copying objects: CopyObject
• Listing objects, or getting information about a single object: ListObjects, GetObjectInfo
• Updating an object's canned ACL: UpdateObjectACL

Working with Multipart Uploads

For S3 providers which support them, multipart uploads make it possible to upload very large objects in multiple parts.

• Starting, completing, and aborting multipart uploads: StartMultipartUpload, CompleteMultipartUpload, AbortMultipartUpload
• Listing multipart uploads: ListMultipartUploads
• Uploading an copying parts: UploadPart, CopyPart
• Listing parts: ListParts

Other Features

The S3 class also supports a variety of other features:

• Versioning support
• Object metadata manipulation
• Pre-signed link generation
• And more!

Property List

---

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

AccessKey	The access key to use for authentication.
AccessPolicy	The canned access policy to apply to a bucket or object.
Bucket	Selects a bucket.
BucketsCount	The number of records in the Buckets arrays.
BucketsCreationDate	The creation date of the bucket.
BucketsName	The name of the bucket.
BucketsOwnerDisplayName	The display name of the bucket's owner.
BucketsOwnerId	The Id of the bucket's owner.
ContentDisposition	Content disposition to send for an object.
ContentType	Content type to send for an object.
EncryptionAlgorithm	The encryption algorithm.
EncryptionPassword	The encryption password.
FirewallAutoDetect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the transmission control protocol (TCP) port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the class.
LocalFile	The location of the local file.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MetadataCount	The number of records in the Metadata arrays.
MetadataName	The name of the metadata item.
MetadataValue	The value of the metadata item.
ObjectData	The data that was downloaded, or that should be uploaded.
ObjectDelimiter	The delimiter string to use when listing objects.
ObjectMarker	A marker indicating what page of objects to return next.
ObjectPrefix	A prefix used to restrict the results returned when listing objects.
ObjectsCount	The number of records in the Objects arrays.
ObjectsDeleted	Whether this object version is a delete marker.
ObjectsETag	The ETag of the object.
ObjectsLastModified	The last modified time of the object.
ObjectsLatestVersion	Whether this is the latest object version.
ObjectsName	The name (key) of the object.
ObjectsOwnerDisplayName	The display name of the object's owner.
ObjectsOwnerId	The Id of the object's owner.
ObjectsSize	The size of the object.
ObjectsStorageClass	The storage class of the object.
ObjectsUploadId	The upload Id of the multipart upload.
ObjectsVersionId	The Id of the object version.
OtherHeaders	Other headers as determined by the user (optional).
Overwrite	Determines if local files are overwritten.
ParsedHeaderCount	The number of records in the ParsedHeader arrays.
ParsedHeaderField	This property contains the name of the HTTP header (this is the same case as it is delivered).
ParsedHeaderValue	This property contains the header contents.
PartMarker	A marker indicating what page of parts to return next.
PartsCount	The number of records in the Parts arrays.
PartsETag	The ETag of the part.
PartsLastModified	The last modified time of the part.
PartsObjectName	The name (key) of the object the part was uploaded for.
PartsOwnerDisplayName	The display name of the part's owner.
PartsOwnerId	The Id of the part's owner.
PartsNumber	The number of the part.
PartsSize	The size of the part.
ProxyAuthScheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
QueryParamCount	The number of records in the QueryParam arrays.
QueryParamName	The name of the query parameter.
QueryParamValue	The value of the query parameter.
Range	The range of bytes to request.
Region	The region the class will make requests against.
SecretKey	The secret key to use for authentication.
ServiceProvider	The S3 service provider to use.
SSLAcceptServerCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertEncoded	This is the certificate (PEM/base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/base64 encoded).
StartByte	The byte offset from which to resume the upload or download.
Timeout	A timeout for the class.
UseSSL	Whether to use SSL/TLS when connecting.
UseVirtualHosting	Determines which URL style to use when making requests.
VersionId	The object version to make requests against.
VersionMarker	A marker indicating what page of object versions to return next.

Method List

---

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

AbortMultipartUpload	Aborts a multipart upload.
AddMetadata	Adds a metadata item to the Metadata properties.
AddQueryParam	Adds a query parameter to the QueryParams properties.
BucketExists	Checks whether the bucket exists.
CheckVersioningEnabled	TBD.
CompleteMultipartUpload	Completes a multipart upload by assembling previously uploaded parts.
Config	Sets or retrieves a configuration setting.
CopyObject	Copies an object.
CopyPart	Copies the specified object as a part of a multipart upload.
CreateBucket	Creates a new bucket.
CreateObject	Creates a new object in the currently selected bucket.
DeleteBucket	Deletes a bucket.
DeleteObject	Deletes an object.
DisableVersioning	TBD.
DoEvents	Processes events from the internal message queue.
EnableVersioning	TBD.
GetBucketLocation	Gets a bucket's location.
GetLink	Creates a link that provides access to an object for a specified amount of time.
GetObject	Downloads an object.
GetObjectInfo	Gets an object's information and metadata.
Interrupt	Interrupt the current method.
ListBuckets	Lists all buckets in the account.
ListMultipartUploads	Lists the current multipart uploads.
ListObjects	Lists the objects in a bucket.
ListParts	Lists the parts in a multipart upload.
ListVersions	Lists the object versions in a bucket.
Reset	Resets the class to its initial state.
ResetHeaders	Resets all HTTP headers, cookies, and LocalFile.
SendCustomRequest	Sends a custom request to the server.
StartMultipartUpload	Starts a new multipart upload.
UpdateBucketACL	Updates a bucket's canned access policy.
UpdateObjectACL	Updates an object's canned access policy.
UploadPart	Uploads a multipart upload part.

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.

BucketList	Fires once for each bucket returned when listing buckets.
EndTransfer	This event fires when a document finishes transferring.
Error	Information about errors during data delivery.
FragmentComplete	Fires after each part in an automatic multipart upload is complete.
Header	Fired every time a header line comes in.
Log	Fires once for each log message.
MetadataList	Fires once for each metadata item returned when object information and metadata is retrieved.
ObjectList	Fires once for each object, object version, or multipart upload returned when listing such items.
PartList	Fires once for every part returned when listing a multipart upload's parts.
PrefixList	Fires once for each common prefix returned when listing objects.
Progress	Fires during an upload or download to indicate transfer progress.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	This event fires when a document starts transferring (after the headers).
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

---

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

AccumulatePages	Whether the class should accumulate subsequent pages of results when listing them.
AssumeRoleARN	Amazon Resource Name used when assuming a role for authentication.
AssumeRoleDuration	The durration for role session in seconds.
AssumeRoleSessionName	Unique name for current role session.
AutoDetectSigningRegion	Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process.
AWSProfile	The name of the AWS CLI profile that the class should use to obtain authentication and region information.
AWSProfileDir	The location of the AWS CLI credentials and config files.
ContentRange	This contains the range of bytes of the current object that are being returned.
CopyPartRange	Specifies the range of bytes to copy when calling CopyPart.
DownloadTempFile	The temporary file used when downloading encrypted data.
EncodeSlashInObjectName	Whether or not to encode slashes in an object name.
EncryptionIV	The initialization vector to be used for encryption/decryption.
EncryptionKey	The key to use during encryption/decryption.
EnforceBucketNameRestrictions	Whether or not to enforce bucket naming conventions.
ETag	The ETag for the object returned by the server.
ForceDeleteNonEmptyBuckets	Forces buckets to be deleted even if they aren't empty.
FragmentSize	The part size to use when uploading a new object.
GoogleProjectId	The Google project Id to send when using OAuth 2.0 to authenticate to Google Storage.
IfMatch	Check to make sure the object has not been modified since the last request.
IncludeContentMD5	Whether an MD5 digest of a custom request's data should be included.
IncludeObjectMD5	Whether an MD5 digest of a object's data should be included.
IncludePartMD5	Whether an MD5 digest of a part's data should be included.
MaskSensitive	Whether sensitive data is masked in the Log event.
MaxObjects	The maximum number of results to return when listing objects.
MaxParts	The maximum number of results to return when listing parts.
OAuthAuthorization	The OAuth 2.0 authorization token to use to authenticate to Google Storage.
OracleNamespace	The Oracle Cloud Object Storage namespace to use.
Prefix[i]	The i'th common prefix returned.
PrefixCount	The number of common prefixed returned.
ProgressAbsolute	Whether the class should track transfer progress absolutely.
ProgressStep	How often the progress event should be fired, in terms of percentage.
RawRequest	Returns the data that was sent to the server.
RawResponse	Returns the data that was received from the server.
ResponseCacheControl	Sets the Cache-Control header of the response.
ResponseContentDisposition	Sets the Content-Disposition header of the response.
ResponseContentEncoding	Sets the Content-Encoding header of the response.
ResponseContentLanguage	Sets the Content-Language header of the response.
ResponseContentType	Sets the Content-Type header of the response.
ResponseExpires	Sets the Expires header of the response.
ResumableUploadState	Tracks upload state information during an automatic multipart upload.
SendObjectACLs	Whether to include object-level ACL headers when making requests.
SessionToken	The session token to send in the request when using temporary credentials.
SignCustomRequest	Tells the class to sign the outgoing request.
SigningTime	A custom date to send to the class to use while signing all requests.
SimpleUploadLimit	The maximum data size the class should attempt to upload directly when creating an object.
StorageClass	Specifies the storage class to be used for the uploaded object.
StoreObjectData	Whether class stores object data or not.
StorePrefixList	Whether to store the common prefixes returned when listing objects.
TempPath	The path to the directory where temporary files are created.
URL	The base URL to use when communicating with a service provider.
UseEC2RoleCredentials	Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance.
XChildCount	The 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.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the returned XML or JSON response.
XSubTree	A snapshot of the current element in the document.
XText	The text of the current element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to true the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

AccessKey Property (S3 Class)

The access key to use for authentication.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

AccessPolicy Property (S3 Class)

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

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

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

Valid values are:

ptPrivate (0) (default)	Owner gets full control, no one else has access.
ptPublicRead (1)	Owner gets full control, everyone else gets read access.
ptPublicReadWrite (2)	Owner gets full control, everyone else gets read/write access.
ptAuthenticatedRead (3)	Owner gets full control, authenticated users get read access.
ptBucketOwnerRead (4)	Only applicable for objects. Object owner gets full control, bucket owner gets read access.
ptBucketOwnerFullControl (5)	Only applicable for objects. Both object and bucket owner get full control.
ptNone (6)	(Instructs the class to not explicitly set a canned access policy for a bucket or object.)

Note: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or have additional restrictions. Refer to a provider's documentation for more information.

Data Type

Integer

Bucket Property (S3 Class)

Selects a bucket.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

BucketsCount Property (S3 Class)

The number of records in the Buckets arrays.

Syntax

int GetBucketsCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• BucketsCreationDate
• BucketsName
• BucketsOwnerDisplayName
• BucketsOwnerId

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

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

Data Type

Integer

BucketsCreationDate Property (S3 Class)

The creation date of the bucket.

Syntax

QString GetBucketsCreationDate(int iBucketsIndex);

Default Value

""

Remarks

The creation date of the bucket.

This property reflects the creation date of the bucket.

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

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

Data Type

String

BucketsName Property (S3 Class)

The name of the bucket.

Syntax

QString GetBucketsName(int iBucketsIndex);

Default Value

""

Remarks

The name of the bucket.

This property reflects the name of the bucket.

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

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

Data Type

String

BucketsOwnerDisplayName Property (S3 Class)

The display name of the bucket's owner.

Syntax

QString GetBucketsOwnerDisplayName(int iBucketsIndex);

Default Value

""

Remarks

The display name of the bucket's owner.

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

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

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

Data Type

String

BucketsOwnerId Property (S3 Class)

The Id of the bucket's owner.

Syntax

QString GetBucketsOwnerId(int iBucketsIndex);

Default Value

""

Remarks

The Id of the bucket's owner.

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

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

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

Data Type

String

ContentDisposition Property (S3 Class)

Content disposition to send for an object.

Syntax

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

ContentType Property (S3 Class)

Content type to send for an object.

Syntax

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

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (S3 Class)

The encryption algorithm.

Syntax

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)

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

The encryption password.

Syntax

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

Default Value

""

Remarks

If this property is populated when CreateObject or GetObject 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 (S3 Class)

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

Syntax

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

This property determines the type of firewall to connect through.

Syntax

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

Possible Values

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

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

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

Syntax

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

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

Syntax

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

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

Syntax

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

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

Syntax

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

Default Value

""

Remarks

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

Data Type

String

FollowRedirects Property (S3 Class)

Determines what happens when the server issues a redirect.

Syntax

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

Possible Values

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

Default Value

0

Remarks

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

frNever (0) (default)	Redirects are never followed; the class fails with an error instead.
frAlways (1)	Redirects are always followed.
frSameScheme (2)	Redirects are followed if the new URL has the same scheme as the originally requested URL; otherwise, the class fails with an error.

Data Type

Integer

Idle Property (S3 Class)

The current status of the class.

Syntax

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

The location of the local file.

Syntax

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

Default Value

""

Remarks

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

Data Type

String

LocalHost Property (S3 Class)

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

Syntax

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

Default Value

""

Remarks

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

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

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

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

Data Type

String

MetadataCount Property (S3 Class)

The number of records in the Metadata arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

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

This property is not available at design time.

Data Type

Integer

MetadataName Property (S3 Class)

The name of the metadata item.

Syntax

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

Default Value

""

Remarks

The name of the metadata item.

This property specifies the name of the metadata item. Keep in mind that the server stores metadata names in lowercase.

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

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

This property is not available at design time.

Data Type

String

MetadataValue Property (S3 Class)

The value of the metadata item.

Syntax

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

Default Value

""

Remarks

The value of the metadata item.

This property specifies the value of the metadata item.

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

This property is not available at design time.

Data Type

String

ObjectData Property (S3 Class)

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

Syntax

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

Default Value

""

Remarks

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

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

This property is not available at design time.

Data Type

Byte Array

ObjectDelimiter Property (S3 Class)

The delimiter string to use when listing objects.

Syntax

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

Default Value

""

Remarks

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

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

Object Hierarchy Traversal

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

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

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

ObjectPrefix Value	ObjectDelimiter Value	Objects Returned	Prefixes Returned
(empty)	/	(none)	MyCompany/
MyCompany/	/	MyCompany/	MyCompany/Department1/ MyCompany/Department2/
MyCompany/Department2/	/	MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB	(none)

This property is not available at design time.

Data Type

String

ObjectMarker Property (S3 Class)

A marker indicating what page of objects to return next.

Syntax

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

Default Value

""

Remarks

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

Refer to ListObjects for more information.

Note: This property is cleared anytime ServiceProvider changes; marker values are only valid when used with the provider that generated them.

This property is not available at design time.

Data Type

String

ObjectPrefix Property (S3 Class)

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

Syntax

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

Default Value

""

Remarks

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

Object Hierarchy Traversal

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

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

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

ObjectPrefix Value	ObjectDelimiter Value	Objects Returned	Prefixes Returned
(empty)	/	(none)	MyCompany/
MyCompany/	/	MyCompany/	MyCompany/Department1/ MyCompany/Department2/
MyCompany/Department2/	/	MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB	(none)

This property is not available at design time.

Data Type

String

ObjectsCount Property (S3 Class)

The number of records in the Objects arrays.

Syntax

int GetObjectsCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

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

Data Type

Integer

ObjectsDeleted Property (S3 Class)

Whether this object version is a delete marker.

Syntax

bool GetObjectsDeleted(int iObjectsIndex);

Default Value

false

Remarks

Whether this object version is a delete marker.

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

Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty.; false in all other cases.

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

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

Data Type

Boolean

ObjectsETag Property (S3 Class)

The ETag of the object.

Syntax

QString GetObjectsETag(int iObjectsIndex);

Default Value

""

Remarks

The ETag of the object.

This property reflects the ETag of the object.

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

Not applicable when ListMultipartUploads is called.

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

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

Data Type

String

ObjectsLastModified Property (S3 Class)

The last modified time of the object.

Syntax

QString GetObjectsLastModified(int iObjectsIndex);

Default Value

""

Remarks

The last modified time of the object.

This property reflects the last modified time of the object.

Not applicable when ListMultipartUploads is called.

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

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

Data Type

String

ObjectsLatestVersion Property (S3 Class)

Whether this is the latest object version.

Syntax

bool GetObjectsLatestVersion(int iObjectsIndex);

Default Value

true

Remarks

Whether this is the latest object version.

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

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

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

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

Data Type

Boolean

ObjectsName Property (S3 Class)

The name (key) of the object.

Syntax

QString GetObjectsName(int iObjectsIndex);

Default Value

""

Remarks

The name (key) of the object.

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

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

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

Data Type

String

ObjectsOwnerDisplayName Property (S3 Class)

The display name of the object's owner.

Syntax

QString GetObjectsOwnerDisplayName(int iObjectsIndex);

Default Value

""

Remarks

The display name of the object's owner.

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

Not applicable when GetObjectInfo is called.

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

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

Data Type

String

ObjectsOwnerId Property (S3 Class)

The Id of the object's owner.

Syntax

QString GetObjectsOwnerId(int iObjectsIndex);

Default Value

""

Remarks

The Id of the object's owner.

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

Not applicable when GetObjectInfo is called.

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

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

Data Type

String

ObjectsSize Property (S3 Class)

The size of the object.

Syntax

qint64 GetObjectsSize(int iObjectsIndex);

Default Value

0

Remarks

The size of the object.

This property reflects the size of the object, in bytes.

Not applicable when ListMultipartUploads is called.

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

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

Data Type

Long64

ObjectsStorageClass Property (S3 Class)

The storage class of the object.

Syntax

QString GetObjectsStorageClass(int iObjectsIndex);

Default Value

""

Remarks

The storage class of the object.

This property reflects the storage class of the object.

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

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

Data Type

String

ObjectsUploadId Property (S3 Class)

The upload Id of the multipart upload.

Syntax

QString GetObjectsUploadId(int iObjectsIndex);

Default Value

""

Remarks

The upload Id of the multipart upload.

This property reflects the upload Id of the multipart upload.

Only applicable when ListMultipartUploads is called.

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

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

Data Type

String

ObjectsVersionId Property (S3 Class)

The Id of the object version.

Syntax

QString GetObjectsVersionId(int iObjectsIndex);

Default Value

""

Remarks

The Id of the object version.

This property reflects the Id of the object version. Note that the string null is a valid version Id.

Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty.; empty in all other cases.

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

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

Data Type

String

OtherHeaders Property (S3 Class)

Other headers as determined by the user (optional).

Syntax

QString GetOtherHeaders();
int SetOtherHeaders(QString qsOtherHeaders);

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType, From, etc.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

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

This property is not available at design time.

Data Type

String

Overwrite Property (S3 Class)

Determines if local files are overwritten.

Syntax

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

Default Value

false

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (S3 Class)

The number of records in the ParsedHeader arrays.

Syntax

int GetParsedHeaderCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

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

Data Type

Integer

ParsedHeaderField Property (S3 Class)

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

Syntax

QString GetParsedHeaderField(int iParsedHeaderIndex);

Default Value

""

Remarks

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

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

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

Data Type

String

ParsedHeaderValue Property (S3 Class)

This property contains the header contents.

Syntax

QString GetParsedHeaderValue(int iParsedHeaderIndex);

Default Value

""

Remarks

This property contains the Header contents.

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

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

Data Type

String

PartMarker Property (S3 Class)

A marker indicating what page of parts to return next.

Syntax

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

Default Value

""

Remarks

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

Refer to ListParts for more information.

Note: This property is cleared anytime ServiceProvider changes; marker values are only valid when used with the provider that generated them. Also, this property is not applicable when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

This property is not available at design time.

Data Type

String

PartsCount Property (S3 Class)

The number of records in the Parts arrays.

Syntax

int GetPartsCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

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

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

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

Data Type

Integer

PartsETag Property (S3 Class)

The ETag of the part.

Syntax

QString GetPartsETag(int iPartsIndex);

Default Value

""

Remarks

The ETag of the part.

This property reflects the ETag of the part.

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

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

Data Type

String

PartsLastModified Property (S3 Class)

The last modified time of the part.

Syntax

QString GetPartsLastModified(int iPartsIndex);

Default Value

""

Remarks

The last modified time of the part.

This property reflects the last modified time of the part.

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

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

Data Type

String

PartsObjectName Property (S3 Class)

The name (key) of the object the part was uploaded for.

Syntax

QString GetPartsObjectName(int iPartsIndex);

Default Value

""

Remarks

The name (key) of the object the part was uploaded for.

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

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

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

Data Type

String

PartsOwnerDisplayName Property (S3 Class)

The display name of the part's owner.

Syntax

QString GetPartsOwnerDisplayName(int iPartsIndex);

Default Value

""

Remarks

The display name of the part's owner.

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

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

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

Data Type

String

PartsOwnerId Property (S3 Class)

The Id of the part's owner.

Syntax

QString GetPartsOwnerId(int iPartsIndex);

Default Value

""

Remarks

The Id of the part's owner.

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

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

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

Data Type

String

PartsNumber Property (S3 Class)

The number of the part.

Syntax

int GetPartsNumber(int iPartsIndex);

Default Value

0

Remarks

The number of the part.

This property reflects the number of the part.

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

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

Data Type

Integer

PartsSize Property (S3 Class)

The size of the part.

Syntax

qint64 GetPartsSize(int iPartsIndex);

Default Value

0

Remarks

The size of the part.

This property reflects the size of the part, in bytes.

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

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

Data Type

Long64

ProxyAuthScheme Property (S3 Class)

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

Syntax

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)

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 only used 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 (S3 Class)

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

Syntax

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

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

Syntax

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

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

Syntax

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

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (S3 Class)

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

Syntax

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 and 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 (S3 Class)

This property determines when to use SSL for the connection to the proxy.

Syntax

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

Possible Values

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

Default Value

0

Remarks

This property determines when to use SSL for the connection to the proxy. The applicable values are the following:

psAutomatic (0)	Default setting. If the URL is an "https" URL, the class will use the psTunnel option. If the URL is a "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 through a tunneling (HTTP) proxy.

Data Type

Integer

ProxyUser Property (S3 Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

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

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

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

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

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

Data Type

String

QueryParamCount Property (S3 Class)

The number of records in the QueryParam arrays.

Syntax

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

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

This property is not available at design time.

Data Type

Integer

QueryParamName Property (S3 Class)

The name of the query parameter.

Syntax

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

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

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

This property is not available at design time.

Data Type

String

QueryParamValue Property (S3 Class)

The value of the query parameter.

Syntax

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

Default Value

""

Remarks

The value of the query parameter.

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

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

This property is not available at design time.

Data Type

String

Range Property (S3 Class)

The range of bytes to request.

Syntax

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

Default Value

""

Remarks

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

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

• StartByte-
• StartByte-EndByte

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

This property is not available at design time.

Data Type

String

Region Property (S3 Class)

The region the class will make requests against.

Syntax

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

Default Value

"us-east-1"

Remarks

This property controls which region the class will make requests against; it should be changed to create or access resources in other regions.

Each service provider has a different default region, and the class will automatically set this property to the selected service provider's default region anytime ServiceProvider changes. The custom service provider's "default region" is empty string (i.e., setting ServiceProvider to spCustom (255) will clear this property).

Note: When the custom service provider is selected, the class uses the base URL specified by the URL configuration setting to generate request URLs. If the base URL contains a %region% token, the class will replace it with this property's value anytime it generates a request URL. Refer to the URL setting's documentation for more information.

Amazon S3 Regions

Value	Region
us-east-1 (Default)	US East (N. Virginia)
us-east-2	US East (Ohio)
us-west-1	US West (N. California)
us-west-2	US West (Oregon)
ap-east-1	Asia Pacific (Hong Kong)
ap-northeast-1	Asia Pacific (Tokyo)
ap-northeast-2	Asia Pacific (Seoul)
ap-northeast-3	Asia Pacific (Osaka-Local)
ap-south-1	Asia Pacific (Mumbai)
ap-southeast-1	Asia Pacific (Singapore)
ap-southeast-2	Asia Pacific (Sydney)
ca-central-1	Canada (Central)
cn-north-1	China (Beijing)
cn-northwest-1	China (Ningxia)
eu-central-1	Europe (Frankfurt)
eu-north-1	Europe (Stockholm)
eu-south-1	Europe (Milan)
eu-west-1	Europe (Ireland)
eu-west-2	Europe (London)
eu-west-3	Europe (Paris)
me-south-1	Middle East (Bahrain)
sa-east-1	South America (Sao Paulo)

Alibaba Cloud Object Storage Regions

Value	Region
oss-ap-northeast-1	Japan (Tokyo)
oss-ap-south-1	India (Mumbai)
oss-ap-southeast-1	Singapore
oss-ap-southeast-2	Australia (Sydney)
oss-ap-southeast-3	Malaysia (Kuala Lumpur)
oss-ap-southeast-5	Indonesia (Jakarta)
oss-cn-beijing (default)	China (Beijing)
oss-cn-chengdu	China (Chengdu)
oss-cn-hangzhou	China (Hangzhou)
oss-cn-heyuan	China (Heyuan)
oss-cn-hongkong	China (Hong Kong)
oss-cn-huhehaote	China (Hohhot)
oss-cn-qingdao	China (Qingdao)
oss-cn-shanghai	China (Shanghai)
oss-cn-shenzhen	China (Shenzhen)
oss-cn-zhangjiakou	China (Zhangjiakou)
oss-eu-central-1	Germany (Frankfurt)
oss-eu-west-1	UK (London)
oss-me-east-1	UAE (Dubai)
oss-us-east-1	US (Virginia)
oss-us-west-1	US (Silicon Valley)

Backblaze B2 Regions

All BackblazeB2 region strings take the form us-west-###, where ### is a 3-digit number. By default, the class uses us-west-000.

To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string.

Note: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a non-master application key if necessary.

Digital Ocean Spaces Regions

Value	Region
ams2	Amsterdam 2
ams3	Amsterdam 3
blr1	Bangalore 1
fra1	Frankfurt 1
lon1	London 1
nyc1	New York 1
nyc2	New York 2
nyc3 (Default)	New York 3
sfo1	San Francisco 1
sfo2	San Francisco 2
sgp1	Singapore 1
tor1	Toronto 1

Google Cloud Storage Regions

Value	Region
us* (Default)	Multiple US data centers
us-central1	US Central (Iowa)
us-east1	US East (South Carolina)
us-east4	US East (Northern Virginia)
us-west1	US West (Oregon)
us-west2	US West (Los Angeles)
asia*	Multiple Asia data centers
asia-east1	Asia East (Taiwan)
asia-east2	Asia East (Hong Kong)
asia-northeast1	Asia Northeast (Tokyo)
asia-south1	Asia South (Mumbai)
asia-southeast1	Asia Southeast (Singapore)
australia-southeast1	Australia Southeast (Sydney)
eu*	Multiple EU data centers
europe-north1	Europe North (Finland)
europe-west1	Europe West (Belgium)
europe-west2	Europe West (London)
europe-west3	Europe West (Frankfurt)
europe-west4	Europe West (Netherlands)
northamerica-northeast1	Canada (Montreal)
southamerica-east1	Brazil (Sao Paulo)

(* denotes a multi-regional location)

Huawei Cloud Object Storage Regions

Value	Region
af-south-1	Johannesburg
ap-southeast-1	Hong Kong
ap-southeast-2	Bangkok
ap-southeast-3	Singapore
cn-east-2	Shanghai
cn-east-3	Shanghai
cn-north-1 (default)	Beijing
cn-north-4	Beijing
cn-south-1	Guangzhou
la-south-2	Santiago
na-mexico-1	Mexico City
sa-argentina-1	Buenos Aires
sa-brazil-1	Sao Paulo
sa-chile-1	Santiago
sa-peru-1	Lima

IBM Cloud Object Storage Regions

Value	Region
Cross-Region
us (default)	US Cross Region
dal.us	US Cross Region (Dallas Access Point)
sjc.us	US Cross Region (San Jose Access Point)
wdc.us	US Cross Region (Washington DC Access Point)
eu	EU Cross Region
ams.eu	EU Cross Region (Amsterdam Access Point)
fra.eu	EU Cross Region (Frankfurt Access Point)
mil.eu	EU Cross Region (Milan Access Point)
ap	Asia Pacific Cross Region
hkg.ap	Asia Pacific Cross Region (Hong Kong Access Point)
seo.ap	Asia Pacific Cross Region (Seoul Access Point)
tok.ap	Asia Pacific Cross Region (Tokyo Access Point)
Regional
au-syd	Australia (Sydney)
eu-de	EU (Germany)
eu-gb	EU (United Kingdom)
jp-tok	Japan (Tokyo)
us-east	US (East)
us-south	US (South)
Single-Site
ams03	Netherlands (Amsterdam)
che01	India (Chennai)
hkg02	Hong Kong
mel01	Australia (Melbourne)
mex01	Mexico (Mexico City)
mil01	Italy (Milan)
mon01	Canada (Montreal)
osl01	Norway (Oslo)
par01	France (Paris)
sao01	Brazil (Sao Paulo)
seo01	South Korea (Seoul)
sjc04	US (San Jose)
sng01	Singapore
tor01	Canada (Toronto)

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

Linode Object Storage Regions

Value	Region
us-east-1 (default)	US East (Newark)
eu-central-1	EU Central (Frankfurt)

Important: Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters do not interact with each other in any way, which causes the following non-standard behaviors:

• Bucket names may be reused in each region (however, they must still be "globally" unique within each region).
• The ListBuckets method will only return buckets located in the currently-selected region; there is no way to retrieve a list of all regions' buckets.
• Similarly, the BucketExists and GetBucketLocation methods only consider buckets located in the currently-selected region.
• The CopyObject method cannot be used to copy objects to a bucket in another region.

Oracle Cloud Object Storage Regions

Value	Region
Commercial Cloud Regions
ap-hyderabad-1	India South (Hyderabad)
ap-melbourne-1	Australia Southeast (Melbourne)
ap-mumbai-1	India West (Mumbai)
ap-osaka-1	Japan Central (Osaka)
ap-seoul-1	South Korea Central (Seoul)
ap-sydney-1	Australia East (Sydney)
ap-tokyo-1	Japan East (Tokyo)
ca-montreal-1	Canada Southeast (Montreal)
ca-toronto-1	Canada Southeast (Toronto)
eu-amsterdam-1	Netherlands Northwest (Amsterdam)
eu-frankfurt-1	Germany Central (Frankfurt)
eu-zurich-1	Switzerland North (Zurich)
me-jeddah-1	Saudi Arabia West (Jeddah)
sa-saopaulo-1	Brazil East (Sao Paulo)
uk-london-1	UK South (London)
us-ashburn-1 (default)	US East (Ashburn, VA)
us-phoenix-1	US West (Phoenix, AZ)
US Gov FedRAMP High Regions
us-langley-1	US Gov East (Ashburn, VA)
us-luke-1	US Gov West (Phoenix, AZ)
US Gov DISA IL5 Regions
us-gov-ashburn-1	US DoD East (Ashburn, VA)
us-gov-chicago-1	US DoD North (Chicago, IL)
us-gov-phoenix-1	US DoD West (Phoenix, AZ)

Wasabi Regions

Value	Region
eu-central-1	Europe (Amsterdam)
us-east-1 (Default)	US East (Ashburn, VA)
us-east-2	US East (Manassas, VA)
us-west-1	US West (Hillsboro, OR)

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value for the currently-selected ServiceProvider.

Data Type

String

SecretKey Property (S3 Class)

The secret key to use for authentication.

Syntax

QString GetSecretKey();
int SetSecretKey(QString qsSecretKey);

Default Value

""

Remarks

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

Data Type

String

ServiceProvider Property (S3 Class)

The S3 service provider to use.

Syntax

int GetServiceProvider();
int SetServiceProvider(int iServiceProvider);

Possible Values

SP_AMAZON_S3(0), 
SP_DIGITAL_OCEAN(1), 
SP_GOOGLE_STORAGE(2), 
SP_WASABI(3), 
SP_BACKBLAZE_B2(4), 
SP_HUAWEI(5), 
SP_ALIBABA(6), 
SP_IBM(7), 
SP_ORACLE(8), 
SP_LINODE(9), 
SP_CUSTOM(255)

Default Value

0

Remarks

This property specifies the S3 service provider that the class should use. Possible values are:

spAmazonS3 (0) (default)	Amazon S3
spDigitalOcean (1)	Digital Ocean Spaces
spGoogleStorage (2)	Google Cloud Storage
spWasabi (3)	Wasabi
spBackblazeB2 (4)	Backblaze B2
spHuawei (5)	Huawei Cloud Object Storage
spAlibaba (6)	Alibaba Cloud Object Storage
spIBM (7)	IBM Cloud Object Storage
spOracle (8)	Oracle Cloud Object Storage
spLinode (9)	Linode Object Storage
spCustom (255)	Custom service provider

Note that the following providers require additional configuration before requests can be made:

• spOracle (8): An "Object Storage Namespace" must be specified using the OracleNamespace configuration setting.
• spCustom (255): A base URL must be specified using the URL configuration setting.

Changing this property will automatically:

• Set the Region property to the default region for the provider (empty string for spCustom (255)).
• Reset the UseSSL property to true.
• Reset the StartByte property to 0.
• Clear the ObjectMarker, PartMarker, and VersionMarker properties, as well as the StorageClass and ResumableUploadState configuration settings.

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEncoded Property (S3 Class)

This is the certificate (PEM/base64 encoded).

Syntax

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

Byte Array

SSLCertEncoded Property (S3 Class)

This is the certificate (PEM/base64 encoded).

Syntax

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

Byte Array

SSLCertStore Property (S3 Class)

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

Syntax

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

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root 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. PKCS12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (S3 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

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

This is the type of certificate store for this certificate.

Syntax

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_AUTO(99)

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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).
20 (cstSecurityKey)	The certificate is present on a physical security key accessible via a PKCS11 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 cstSecurityKey, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 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.cstSecurityKey; 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.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);
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.
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 (S3 Class)

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

Syntax

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 properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

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

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

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

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

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

Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

Data Type

String

SSLProvider Property (S3 Class)

This specifies the SSL/TLS implementation to use.

Syntax

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

Possible Values

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

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

This is the certificate (PEM/base64 encoded).

Syntax

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

Byte Array

StartByte Property (S3 Class)

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

Syntax

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

Default Value

0

Remarks

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

Note: This property is automatically reset to 0 anytime ServiceProvider changes.

This property is not available at design time.

Data Type

Long64

Timeout Property (S3 Class)

A timeout for the class.

Syntax

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

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseSSL Property (S3 Class)

Whether to use SSL/TLS when connecting.

Syntax

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

Default Value

true

Remarks

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

Note: This property is automatically reset to true anytime ServiceProvider changes. The class will ignore any attempts to change this property while one of the following providers is selected, since they require SSL/TLS to be used:

• spDigitalOcean (1)
• spBackblazeB2 (4)
• spOracle (8)

This property is not available at design time.

Data Type

Boolean

UseVirtualHosting Property (S3 Class)

Determines which URL style to use when making requests.

Syntax

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

Default Value

true

Remarks

If true (default), virtual-hosted-style URLs will be used to make requests: http://yourbucket.s3.amazonaws.com/yourobject. Note that hosted-style URLs impose more bucket name restrictions due to DNS server naming restrictions. Refer to Amazon's documentation for more information.

If false, path-style URLs will be used to make requests: http://s3.amazonaws.com/yourbucket/yourobject.

Important: When using the spAmazonS3 (0) service provider, keep in mind that Amazon has publicly announced that buckets created after September 30, 2020 will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020 will continue to support both URL styles.

Note: This property is ignored when ServiceProvider is set to one of the following:

• spAlibaba (6); Alibaba does not support path-style URLs, only virtual-hosted-style URLs.
• spOracle (8); Oracle Cloud Object Storage does not support virtual-hosted-style URLs, only path-style URLs.

This property is not available at design time.

Data Type

Boolean

VersionId Property (S3 Class)

The object version to make requests against.

Syntax

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

Default Value

""

Remarks

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

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

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

This property is not available at design time.

Data Type

String

VersionMarker Property (S3 Class)

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

Syntax

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

Default Value

""

Remarks

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

Refer to ListVersions for more information.

Note: This property is cleared anytime ServiceProvider changes; marker values are only valid when used with the provider that generated them.

This property is not available at design time.

Data Type

String

AbortMultipartUpload Method (S3 Class)

Aborts a multipart upload.

Syntax

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

Remarks

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

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

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

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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

AddMetadata Method (S3 Class)

Adds a metadata item to the Metadata properties.

Syntax

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

Remarks

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

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

Error Handling

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

AddQueryParam Method (S3 Class)

Adds a query parameter to the QueryParams properties.

Syntax

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

Remarks

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

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

Error Handling

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

BucketExists Method (S3 Class)

Checks whether the bucket exists.

Syntax

bool BucketExists();

Remarks

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

Note: When ServiceProvider is spLinode (9), this method only considers buckets located in the currently-selected Region. Refer to the Linode section of the Region property's documentation for more information.

Error Handling

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

CheckVersioningEnabled Method (S3 Class)

TBD.

Syntax

bool CheckVersioningEnabled();

Remarks

TBD

Error Handling

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

CompleteMultipartUpload Method (S3 Class)

Completes a multipart upload by assembling previously uploaded parts.

Syntax

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

Remarks

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

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

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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

Config Method (S3 Class)

Sets or retrieves a configuration setting.

Syntax

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

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

CopyObject Method (S3 Class)

Copies an object.

Syntax

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

Remarks

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

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

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

Notes:

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

Error Handling

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

CopyPart Method (S3 Class)

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

Syntax

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

Remarks

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

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

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

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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

CreateBucket Method (S3 Class)

Creates a new bucket.

Syntax

int CreateBucket();

Remarks

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

Error Handling

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

CreateObject Method (S3 Class)

Creates a new object in the currently selected bucket.

Syntax

int CreateObject(const QString& qsObjectName);

Remarks

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

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.

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

Automatic Multipart Uploads

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

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

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

Note: Automatic multipart uploads are not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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

DeleteBucket Method (S3 Class)

Deletes a bucket.

Syntax

int DeleteBucket();

Remarks

This method deletes the bucket currently selected by Bucket. Note that, for some service provider, bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime. Refer to a provider's documentation for more information.

Error Handling

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

DeleteObject Method (S3 Class)

Deletes an object.

Syntax

int DeleteObject(const QString& qsObjectName);

Remarks

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

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

Deleting Versioned Objects

If a bucket has versioning enabled (i.e., VersioningEnabled returns true when queried), and this method is called on an object rather than a specific object version, then instead of actually deleting any data, the server will simply create a special object version called a delete marker.

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

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

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

Error Handling

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

DisableVersioning Method (S3 Class)

TBD.

Syntax

int DisableVersioning();

Remarks

TBD

Error Handling

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

DoEvents Method (S3 Class)

Processes events from the internal message queue.

Syntax

int DoEvents();

Remarks

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

Error Handling

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

EnableVersioning Method (S3 Class)

TBD.

Syntax

int EnableVersioning();

Remarks

TBD

Error Handling

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

GetBucketLocation Method (S3 Class)

Gets a bucket's location.

Syntax

QString GetBucketLocation();

Remarks

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

Note: When ServiceProvider is spLinode (9), this method only considers buckets located in the currently-selected Region. Refer to the Linode section of the Region property's documentation for more information.

Error Handling

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

GetLink Method (S3 Class)

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

Syntax

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

Remarks

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

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

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

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

• spGoogleStorage (2)
• spOracle (8)

Error Handling

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

GetObject Method (S3 Class)

Downloads an object.

Syntax

int GetObject(const QString& qsObjectName);

Remarks

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

If LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.

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

Download Notes

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

Resuming Downloads

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

Resuming Encrypted File Downloads

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

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

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

Error Handling

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

GetObjectInfo Method (S3 Class)

Gets an object's information and metadata.

Syntax

int GetObjectInfo(const QString& qsObjectName);

Remarks

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

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

Error Handling

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

Interrupt the current method.

Syntax

int Interrupt();

Remarks

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

Error Handling

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

ListBuckets Method (S3 Class)

Lists all buckets in the account.

Syntax

int ListBuckets();

Remarks

This method lists all buckets in the account.

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

Note: When ServiceProvider is spLinode (9), this method only returns buckets located in the currently-selected Region, there is no way to retrieve a list all regions' buckets. Refer to the Linode section of the Region property's documentation for more information.

Error Handling

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

ListMultipartUploads Method (S3 Class)

Lists the current multipart uploads.

Syntax

int ListMultipartUploads();

Remarks

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

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

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

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

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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

ListObjects Method (S3 Class)

Lists the objects in a bucket.

Syntax

int ListObjects();

Remarks

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

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

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

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

Object Hierarchy Traversal

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

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

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

ObjectPrefix Value	ObjectDelimiter Value	Objects Returned	Prefixes Returned
(empty)	/	(none)	MyCompany/
MyCompany/	/	MyCompany/	MyCompany/Department1/ MyCompany/Department2/
MyCompany/Department2/	/	MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB	(none)

Error Handling

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

ListParts Method (S3 Class)

Lists the parts in a multipart upload.

Syntax

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

Remarks

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

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

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

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

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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

ListVersions Method (S3 Class)

Lists the object versions in a bucket.

Syntax

int ListVersions();

Remarks

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

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

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

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

Object Hierarchy Traversal

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

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

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

ObjectPrefix Value	ObjectDelimiter Value	Objects Returned	Prefixes Returned
(empty)	/	(none)	MyCompany/
MyCompany/	/	MyCompany/	MyCompany/Department1/ MyCompany/Department2/
MyCompany/Department2/	/	MyCompany/Department2/ MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB	(none)

Error Handling

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

Resets the class to its initial state.

Syntax

int Reset();

Remarks

This method resets the class to its initial state.

Error Handling

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

ResetHeaders Method (S3 Class)

Resets all HTTP headers, cookies, and LocalFile.

Syntax

int ResetHeaders();

Remarks

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

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

Error Handling

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

SendCustomRequest Method (S3 Class)

Sends a custom request to the server.

Syntax

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

Remarks

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

Valid values for HttpMethod are:

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

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

Usage

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

1. Builds a request URL, including query parameters, based on the following:
   • UseSSL, Region, and UseVirtualHosting for the base URL.
     • Alternatively, if ServiceProvider is spCustom (255), the custom URL specified using the URL configuration setting is used directly, and these properties are ignored.
   • Bucket (if non-empty)
   • ObjectName (if non-empty)
   • VersionId (if both it and ObjectName are non-empty)
   • QueryParam*
2. Adds request headers from:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • SessionToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified LocalFile, or ObjectData (using the same logic as GetObject).

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

Error Handling

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

StartMultipartUpload Method (S3 Class)

Starts a new multipart upload.

Syntax

QString StartMultipartUpload(const QString& qsObjectName);

Remarks

This method starts a new multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. This upload Id can then be used to call the following methods:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

If there are any metadata items present in the Metadata* properties, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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.

UpdateBucketACL Method (S3 Class)

Updates a bucket's canned access policy.

Syntax

int UpdateBucketACL();

Remarks

This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy

Error Handling

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

UpdateObjectACL Method (S3 Class)

Updates an object's canned access policy.

Syntax

int UpdateObjectACL(const QString& qsObjectName);

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.

If the VersionId property is non-empty, the canned access policy of the specified version of the object is updated instead.

Error Handling

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

UploadPart Method (S3 Class)

Uploads a multipart upload part.

Syntax

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

Remarks

This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.

PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly-uploaded part.

The data to upload is taken from either LocalFile or ObjectData (whichever data is found in first, when checked in that order). Each part must be at least 5MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.

If the IncludePartMD5 configuration setting is true, the class will include an MD5 digest of its data when sending it to the server. The server will then verify that the data was received without corruption.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Error Handling

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

BucketList Event (S3 Class)

Fires once for each bucket returned when listing buckets.

Syntax

class S3BucketListEventParams {
public:
  const QString &BucketName();

  const QString &CreationDate();

  const QString &OwnerId();

  const QString &OwnerName();

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

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

// Or, subclass S3 and override this emitter function.
virtual int FireBucketList(S3BucketListEventParams *e) {...}

Remarks

This event fires once for each bucket returned when ListBuckets is called.

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.

EndTransfer Event (S3 Class)

This event fires when a document finishes transferring.

Syntax

class S3EndTransferEventParams {
public:
  int Direction();

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

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

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

Information about errors during data delivery.

Syntax

class S3ErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

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

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

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

Remarks

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

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

FragmentComplete Event (S3 Class)

Fires after each part in an automatic multipart upload is complete.

Syntax

class S3FragmentCompleteEventParams {
public:
  int FragmentNumber();

  int FragmentCount();

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

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

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

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

Remarks

If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part that has completed. This value starts at 1.

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

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

Refer to CreateObject for more information.

Note: This event is not applicable when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

Header Event (S3 Class)

Fired every time a header line comes in.

Syntax

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

  const QString &Value();

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

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

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

Remarks

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

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

Log Event (S3 Class)

Fires once for each log message.

Syntax

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

// Or, subclass S3 and override this emitter function.
virtual int FireLog(S3LogEventParams *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:

0 (None)	No events are logged.
1 (Info - default)	Informational events are logged.
2 (Verbose)	Detailed data is logged.
3 (Debug)	Debug data is 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:

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

MetadataList Event (S3 Class)

Fires once for each metadata item returned when object information and metadata is retrieved.

Syntax

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

  const QString &Value();

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

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

// Or, subclass S3 and override this emitter function.
virtual int FireMetadataList(S3MetadataListEventParams *e) {...}

Remarks

This event fires once for each metadata item returned when GetObjectInfo is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.

Value is the metadata item's value.

ObjectList Event (S3 Class)

Fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

class S3ObjectListEventParams {
public:
  const QString &BucketName();

  const QString &ObjectName();

  const QString &LastModified();

  qint64 Size();

  const QString &ETag();

  const QString &OwnerId();

  const QString &OwnerName();

  const QString &UploadId();

  const QString &VersionId();

  bool LatestVersion();

  bool Deleted();

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

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

// Or, subclass S3 and override this emitter function.
virtual int FireObjectList(S3ObjectListEventParams *e) {...}

Remarks

This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object. Not applicable when ListMultipartUploads is called.

Size reflects the size, in bytes, of the object. Not applicable when ListMultipartUploads is called.

ETag reflects the object's ETag. Not applicable when ListMultipartUploads is called.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when GetObjectInfo is called.

UploadId reflects the Id of the multipart upload. Only applicable when ListMultipartUploads is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty.; empty in all other cases.

LatestVersion indicates whether this is the latest object version. Only applicable when ListVersions is called; true in all other cases.

Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty.; false in all other cases.

PartList Event (S3 Class)

Fires once for every part returned when listing a multipart upload's parts.

Syntax

class S3PartListEventParams {
public:
  int PartNumber();

  const QString &ObjectName();

  const QString &LastModified();

  qint64 Size();

  const QString &ETag();

  const QString &OwnerId();

  const QString &OwnerName();

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

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

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

Remarks

This event fires once for each multipart upload part returned when ListParts is called.

PartNumber reflects the part's number.

ObjectName reflects the name of the object the multipart upload is for.

LastModified reflects the last modified time of the part.

Size reflects the size, in bytes, of the part.

ETag reflects the part's ETag of the part.

OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.

Note: This event is not applicable when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

PrefixList Event (S3 Class)

Fires once for each common prefix returned when listing objects.

Syntax

class S3PrefixListEventParams {
public:
  const QString &BucketName();

  const QString &Prefix();

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

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

// Or, subclass S3 and override this emitter function.
virtual int FirePrefixList(S3PrefixListEventParams *e) {...}

Remarks

This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

Progress Event (S3 Class)

Fires during an upload or download to indicate transfer progress.

Syntax

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

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

Remarks

This event fires during an upload or download to indicate the progress of the transfer. 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.

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

Fired after the server presents its certificate to the client.

Syntax

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

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

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

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

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

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

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

StartTransfer Event (S3 Class)

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

Syntax

class S3StartTransferEventParams {
public:
  int Direction();

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

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

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

Fired while a document transfers (delivers document).

Syntax

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

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

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data is 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 that events are not re-entrant. Performing time consuming operations within this event will prevent it from firing again in a timely manner and may impact overall performance.

Configuration Settings (S3 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.

S3 Configuration Settings

AccumulatePages:   Whether the class should accumulate subsequent pages of results when listing them. This setting controls how the class behaves when listing multiple pages of results. If this setting is enabled, each successive page of results will be appended to the appropriate collection properties until the last page of results has been listed (at which point the next list call will cause said collection to be cleared first). If this setting is disabled, the collection will be cleared every time a page of results is returned. By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.

AssumeRoleARN:   Amazon Resource Name used when assuming a role for authentication. The Amazion Resource Name that will be assumed by the class. Must be set along side AssumeRoleSessionName.

AssumeRoleDuration:   The durration for role session in seconds. The duration of the role session in seconds. The minimum is 900 seconds (15 minuites) and the maximum is 43200 (12 hours). As a note, the maximum value may be lower based on restriction placed by the role administrator. If the duration is outside of the range the request will fail. This setting is optional but AssumeRoleARN and AssumeRoleSessionName are required for assuming a role.

AssumeRoleSessionName:   Unique name for current role session. The unique session name to identify a session within a role. Must be set along side AssumeRoleARN.

AutoDetectSigningRegion:   Whether or not to automatically detect the region from the base URL in order to use it for the HMAC signing process. When set to true (default) the class will automatically try to extract the region from the base URL. When set to false the region provided in the Region property will be used in the signed header for the HMAC signature.

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: Configuration and Credential File Settings Named Profiles Using an IAM Role 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.

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

ContentRange:   This contains the range of bytes of the current object that are being returned. When implementing chunked and resumable object downloads by setting the Range property, this configuration will contain the returned range of bytes and the total count of bytes for the specified object. This configuration will be populated after a call to GetObject

CopyPartRange:   Specifies the range of bytes to copy when calling CopyPart. This setting optionally specifies the range of bytes to copy from the source object when calling CopyPart. By default the entire object is copied as the new part. When set, this setting dictates the 0-based range of bytes to copy in the format [first]-[last]. For example: 2048-4096. Note: This setting is ignored when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

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 GetObject for details.

EncodeSlashInObjectName:   Whether or not to encode slashes in an object name. When set to true (default) the class will URL encode any slashes in an object name when signing a request. This is what Amazon's S3 service expects. Other S3 clones may vary slightly from this rule, requiring that slashes are not encoded. Set this to false to accommodate.

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.

EnforceBucketNameRestrictions:   Whether or not to enforce bucket naming conventions. When set to false (default) the class will not enforce the bucket naming restrictions. US based buckets are not subject to the same name restrictions as other locations. When set to true the class will enforce the following restrictions: Bucket names can contain lowercase letters, numbers, periods, underscores, and dashes. Bucket names must start with a number or letter. Bucket names must be between 3 and 63 characters long. Bucket names should not end with a dash. Bucket names cannot contain two adjacent periods. Bucket names cannot contain dashes next to periods. Bucket names must not be formatted as an IP address (eg: 192.168.5.4).

ETag:   The ETag for the object returned by the server. This contains the ETag for the object returned after GetObject, CreateObject or CompleteMultipartUpload is called. The ETag is used to determine if the object has changed since the last operation on the file. Set the IfMatch config to the ETag to ensure a new version of the object does not already exist on the server.

ForceDeleteNonEmptyBuckets:   Forces buckets to be deleted even if they aren't empty. When DeleteBucket is called, if this is set to true (default), the bucket will be deleted whether it is empty or not. Note: This setting is only applicable when ServiceProvider is spWasabi (3); other providers do not support deleting non-empty buckets.

FragmentSize:   The part size to use when uploading a new object. If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. This setting specifies the part size to use. Valid values are 5242880 (5MB) to 2147483647 (2GB). The default is 26214400 (25MB). Note that applications may need to increase this setting's value in order to upload very large objects; Amazon only allows 10000 parts to be uploaded for any given multipart upload. If the amount of upload data provided when creating an object is less than SimpleUploadLimit bytes, it will be uploaded directly, so this setting will not apply. Note: This setting is ignored when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

GoogleProjectId:   The Google project Id to send when using OAuth 2.0 to authenticate to Google Storage. When the ServiceProvider property is set to spGoogleStorage (2), and the OAuthAuthorization configuration setting is populated, this setting must also be set in order to use OAuth 2.0 to authenticate to Google Storage.

IfMatch:   Check to make sure the object has not been modified since the last request. When implementing chunked and resumable object downloads, the IfMatch config is used to determine if the object has changed since the last chunk was downloaded. Set the IfMatch config to the ETag of the previous request to tell the class to make sure the object has not changed before a call to GetObject.

IncludeContentMD5:   Whether an MD5 digest of a custom request's data should be included. If set to true, the class will include an MD5 digest of the RequestBody passed to SendCustomRequest when the request is submitted. The default value is false. Note that this setting is only applicable if the SignCustomRequest setting is true; it is ignored otherwise.

IncludeObjectMD5:   Whether an MD5 digest of a object's data should be included. If set to true, the class will include an MD5 digest of an object's data when it is created using CreateObject. (If the class performs an automatic multipart upload, MD5 digests of the individual parts' data will be sent instead, even if IncludePartMD5 is false.) The default value is false.

IncludePartMD5:   Whether an MD5 digest of a part's data should be included. If set to true, the class will include an MD5 digest of a part's data when it is uploaded using UploadPart. The default value is false. Note: This setting is ignored when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

MaskSensitive:   Whether sensitive data is masked in the Log event. This setting controls whether sensitive information is masked when the Log event fires. For instance, the Authorization header in the request contains the Access Key Id. The default value is false and no information is masked.

MaxObjects:   The maximum number of results to return when listing objects. This setting specifies the maximum number of results that should be returned by a call to ListObjects or ListMultipartUploads. If this setting is -1 (default), the server's default is used. Acceptable values vary by provider.

MaxParts:   The maximum number of results to return when listing parts. This setting specifies the maximum number of results that should be returned by a call to ListParts. If this setting is -1 (default), the server's default is used. Acceptable values vary by provider. Note: This setting is ignored when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

OAuthAuthorization:   The OAuth 2.0 authorization token to use to authenticate to Google Storage. When the ServiceProvider property is set to spGoogleStorage (2), this setting (along with the GoogleProjectId configuration setting) can be set in order to use OAuth 2.0 to authenticate to Google Storage instead of an AccessKey and SecretKey.

OracleNamespace:   The Oracle Cloud Object Storage namespace to use. When the ServiceProvider property is set to spOracle (8), this setting must be set to the Oracle Cloud Object Storage namespace associated with the Oracle Cloud account before any requests can be made. This setting is not applicable when ServiceProvider is set to any other value. Refer to the Understanding Object Storage Namespaces page of the Oracle Cloud documentation for instructions on how to find your account's Object Storage namespace.

Prefix[i]:   The i'th common prefix returned. When StorePrefixList is enabled, this setting can be used to retrieve the common prefixes returned by the most recent ListObjects request. Refer to that method, as well as the ObjectDelimiter property, for more information. Valid values for i are from 0 to (PrefixCount - 1).

PrefixCount:   The number of common prefixed returned. When StorePrefixList is enabled, this setting reflects the number of common prefixes returned by the most recent ListObjects request. This setting is always -1 when StorePrefixList is disabled.

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.

ResponseCacheControl:   Sets the Cache-Control header of the response. If specified, this determines the Cache-Control header returned by the server. Note that this is only applicable when calling GetLink.

ResponseContentDisposition:   Sets the Content-Disposition header of the response. If specified, this determines the Content-Disposition header returned by the server. Note that this is only applicable when calling GetLink.

ResponseContentEncoding:   Sets the Content-Encoding header of the response. If specified, this determines the Content-Encoding header returned by the server. Note that this is only applicable when calling GetLink.

ResponseContentLanguage:   Sets the Content-Language header of the response. If specified, this determines the Content-Language header returned by the server. Note that this is only applicable when calling GetLink.

ResponseContentType:   Sets the Content-Type header of the response. If specified, this determines the Content-Type header returned by the server. Note that this is only applicable when calling GetLink.

ResponseExpires:   Sets the Expires header of the response. If specified, this determines the Expires header returned by the server. Note that this is only applicable when calling GetLink.

ResumableUploadState:   Tracks upload state information during an automatic multipart upload. If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. This setting keeps track of upload state information needed to resume the upload if it's interrupted. Refer to CreateObject for more information. Note: This setting is automatically cleared anytime ServiceProvider changes. This setting is not applicable when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

SendObjectACLs:   Whether to include object-level ACL headers when making requests. This setting controls whether object-level ACL headers are included when making applicable requests (e.g., CreateObject). When the ServiceProvider property is set to spGoogleStorage (2), it may be necessary to disable this setting if uniform bucket-level access is being used. By default, this setting is enabled, and object-level ACL headers are included.

SessionToken:   The session token to send in the request when using temporary credentials. When using temporary credentials, AWS requires you to send the session token provided with the temporary access and secret key in every request.

SignCustomRequest:   Tells the class to sign the outgoing request. By default, this configuration is true, and when SendCustomRequest is called the class will sign the specified request to authenticate with the service. If set to false, the request will be sent as is, without signing.

SigningTime:   A custom date to send to the class to use while signing all requests. The SigningTime config can be used to send a custom value for the signature date that is used while signing all requests. This is often used if a machine has not been patched or is sending incorrect date values while attempting to connect. This value must be provided as a traditional Unix timestamp. A Unix timestamp is the number of seconds since the Unix Epoch (00:00:00 January 1, 1970 UTC). An example value for the timestamp would be 1236626334.

SimpleUploadLimit:   The maximum data size the class should attempt to upload directly when creating an object. When CreateObject is called, the class will automatically split the upload data into parts and perform a multipart upload if its size is greater than the amount specified by this setting. If the upload data size is less than or equal to the amount specified by this setting, it will be uploaded directly in the object creation request. Valid values are -1 to 5368709120 (5GB), inclusive. The default is 104857600 (100MB). If this setting is set to 0, the class will always perform a multipart upload when creating an object; if it is set to -1, the class will never perform a multipart upload. Note: This setting is ignored when ServiceProvider is spGoogleStorage (2); Google Cloud Storage does not support multipart uploads.

StorageClass:   Specifies the storage class to be used for the uploaded object. This setting specifies the storage class to use for newly-created objects; it is used when constructing CreateObject, StartMultipartUpload, and CopyObject requests. By default, this setting is empty, causing new objects to be created with a provider's default storage class (usually STANDARD, but refer to the provider's documentation for more information). This setting is cleared anytime ServiceProvider changes. Note: The IBM Cloud Object Storage provider assigns storage classes to buckets rather than to individual objects. When ServiceProvider is spIBM (7), this setting can be set to a valid IBM storage class string before calling CreateBucket to create a bucket with the specified storage class. Buckets are created with the standard storage class by default.

StoreObjectData:   Whether class stores object data or not. This configuration setting can be used to instruct the class whether or not to create a local copy of the data to upload when setting the ObjectData property. When set to false, the class will store the data address and length only. This cuts down on the memory usage of the class when uploading files. The default value for this setting is true.

StorePrefixList:   Whether to store the common prefixes returned when listing objects. If this setting is enabled, the class will populate the PrefixCount and Prefix[i] settings anytime ListObjects is called. By default, this setting is disabled.

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 GetObject for more information.

URL:   The base URL to use when communicating with a service provider. This configuration setting can be used to override the URL that will be used when communicating with a service provider. When the ServiceProvider property is set to spCustom (255), this setting must be set to the custom service provider's base URL before any requests can be made. When the class uses the specified base URL to generate a request URL, it performs the following transformations (if necessary): If the base URL includes an http[s]:// prefix, it is ignored; the UseSSL property controls whether the class makes secure or plaintext connections. If the base URL contains a %region% token, it is replaced with the Region property's current value. For example, if this setting is set to http://s3.%region%.myservice.com, UseSSL is true, and Region is region-1, then the class will generate request URLs like https://s3.region-1.myservice.com/bucket/... (or like https://bucket.s3.region-1.myservice.com/..., if the UseVirtualHosting property is true).

UseEC2RoleCredentials:   Whether to authenticate requests with credentials obtained from the IAM role attached to the EC2 instance. When the class is running within an Amazon EC2 instance, this setting can be set to authenticate requests using the IAM role attached to the instance using temporary credentials obtained from the instance metadata service. The IMDSv1 protocol is used by default. Please see the IMDSVersion configuration setting for more information. In order for the class to be able to auto-obtain authentication credentials, the EC2 instance must have an "instance profile" with an appropriate IAM role attached to it. Refer to the "Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances" page in the Amazon IAM documentation for more information. By default, this setting is false. When set to true the class will do the following before each request: Make a request against the EC2 instance to get the name of the role attached to it. Make a request against the metadata service to obtain temporary security credentials for IAM role returned in the previous call. Parse the response, automatically populating the AccessKey and SecretKey properties and the SessionToken configuration setting. Execute the original request using the temporary security credentials that were acquired. Note: This setting is ignored if the AWSProfile setting is set to a profile that includes credential information.

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: Description XML 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 Configuration 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 config 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 setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It will then 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 config. 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 setting controls whether HTTP/2 connections are permitted to fallback to HTTP/1.1 when the server does not support HTTP/2. This setting is only applicable 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 setting determines whether data is 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 only applicable 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 non-empty 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. Returns the raw number of bytes from the HTTP response data, prior to the component processing the data, whether it is chunked and/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 only applicable 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 that 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 could potentially change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server and port are different than 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. Valid options are: 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 via 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: "1.0" "1.1" (default) "2.0" "3.0" When using HTTP/2 ("2.0") additional restrictions apply. Please see notes below for details. HTTP/2 Notes When using HTTP/2 a secure (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 in order 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 only supported in .NET & 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 non-empty 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. An example is: 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 that not all server support persistent connections. You may also explicitly add the Keep-Alive header to the request headers by setting OtherHeaders to 'Connection: Keep-Alive'. 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 setting controls the level of detail that is logged through the Log event. Possible values are: 0 (None) No events are logged. 1 (Info - default) Informational events are logged. 2 (Verbose) Detailed data is logged. 3 (Debug) Debug data is 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 besides 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 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" the class will fallback to using "1.1" automatically. This setting will indicate which was used.

OtherHeaders:   Other headers as determined by the user (optional). This configuration option can be set to a string of headers to be appended to the HTTP request headers. The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") . Use this configuration option with caution. If this configuration option contains invalid headers, HTTP requests may fail. This configuration option is useful for extending the functionality of the class beyond what is provided.

ProxyAuthorization:   The authorization string to be sent to the proxy server. Similar to the Authorization config, but for proxy authorization. If this config contains a non-empty 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 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 setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80). This 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 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 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.

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 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 config to ON before making a request to enable it. Examples are below. .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 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. 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.

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.

IPPort Configuration 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 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;. Note that the FirewallPort is set automatically when FirewallType is set to a valid value. NOTE: This 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: 0 No firewall (default setting). 1 Connect through a tunneling proxy. FirewallPort is set to 80. 2 Connect through a SOCKS4 Proxy. FirewallPort is set to 1080. 3 Connect through a SOCKS5 Proxy. FirewallPort is set to 1080. 10 Connect 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 acknowledgement is received from the remote host the keep-alive packet will be re-sent. This 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.

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 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), there are two scenarios for determining how long the connection will linger. The first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP protocol timeout expires. In the second scenario, 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 is 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 (by a client acknowledgment, for example), 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, to leave the socket connection linger. This value is 0 by default, which means it will use the default IP protocol 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 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 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 Configuration 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.

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate. This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error. When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported. This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

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.3 12288 (Hex 3000) TLS1.2 3072 (Hex C00) (Default) TLS1.1 768 (Hex 300) (Default) TLS1 192 (Hex C0) (Default) SSL3 48 (Hex 30) SSL2 12 (Hex 0C) SSLEnabledProtocols - TLS 1.3 Notes By default when TLS 1.3 is enabled the class will use the internal TLS implementation. 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.

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 ciphersuite. Returns the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength. Returns the strength of the ciphersuite negotiated during the SSL handshake. Note: For server components (e.g. IPDaemon) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

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

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.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API.

Trappable Errors (S3 Class)

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.

IPPort 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   Cannot change 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).