AzureFile Component
Properties Methods Events Config Settings Errors
The AzureFile component provides an easy to use interface to Microsoft's Azure File Storage service.
Syntax
TcsAzureFile
Remarks
The AzureFile component offers an easy-to-use API for the Microsoft Azure File Storage service. Capabilities include uploading and downloading files, strong encryption support, creating folders, file manipulation, and more.
Authentication
Authentication is simple, set the Account property to the name of the Azure Storage account to operate against, and set the AccessKey property to an Azure access key associated with that account.
Addressing Resources
Azure File Storage accounts can contain one or more file shares. Use the ListShares method to list available shares, and select which one the component should operate against using the Share property.
After selecting a share, address the files and folders within it using Linux-style absolute paths. Unless otherwise specified, the component always works in terms of absolute paths, and will always prepend a forward slash (/) to any path passed to it that does not already start with one.
Listing Directory Contents
ListResources lists resources (files and folders) within the specified directory. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.
// ResourceList event handler.
azurefile.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
azurefile.Share = "myshare";
do {
azurefile.ListResources("/work_files/serious_business/cats");
for (int i = 0; i < azurefile.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(azurefile.ResourceMarker));
Downloading Files
The DownloadFile method downloads files.
If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.
To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
azurefile.LocalFile = "../MyFile.zip";
azurefile.DownloadFile(azurefile.Resources[0].Path);
Resuming Downloads
The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
azurefile.LocalFile = downloadFile;
azurefile.DownloadFile(azurefile.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
azurefile.StartByte = new FileInfo(downloadFile).Length;
azurefile.DownloadFile(azurefile.Resources[0].Path);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.
azurefile.LocalFile = "../MyFile.zip";
azurefile.EncryptionPassword = "password";
azurefile.DownloadFile(azurefile.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
azurefile.StartByte = new FileInfo(azurefile.Config("DownloadTempFile")).Length;
azurefile.DownloadFile(azurefile.Resources[0].Path);
Uploading Files
The UploadFile method uploads new files.
If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
Upload Notes
The UploadFile method is a convenience method that performs a resumable file upload. When called, the component first uses CreateFile to initialize a new file entry on the server; and then it fragments the file data into smaller pieces and calls PutRange multiple times in succession to upload those fragments. The fragment size is fixed at 4MB (this is a server limitation that cannot be changed).
During the upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The component also updates StartByte as necessary to indicate the current offset in the file.
If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.
azurefile.LocalFile = "../MyFile.zip";
azurefile.UploadFile("MyFile.zip");
//The transfer is interrupted and UploadFile() above fails. Later, resume the download.
//Using the same instance StartByte is already populated from the previous upload attempt.
azurefile.UploadFile("MyFile.zip");
Additional Functionality
The AzureFile component offers advanced functionality beyond simple uploads and downloads. For instance:
- Encrypt and decrypt files using the EncryptionAlgorithm and EncryptionPassword properties.
- Basic file and folder manipulation and organization using methods such as CreateFolder, CopyFile, DeleteFolder, and DeleteFile.
- Advanced file manipulation with CreateFile, ResizeFile, PutRange, GetRanges, and ClearRange.
- Share manipulation with CreateShare, SetShareQuota, and DeleteShare.
- Retrieval of information and metadata for files, folders, and shares using GetFileInfo, GetFolderInfo, and GetShareInfo.
- And more!
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AccessKey | The Azure access key to use for authentication. |
Account | The Azure storage account name. |
Authorization | OAuth 2.0 Authorization Token. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
FirewallAutoDetect | This property tells the component 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 the 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 username if authentication is to be used when connecting through a firewall. |
Idle | This property specifies the current status of the component. |
LocalFile | The location of the local file. |
LocalHost | This property includes 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. |
OAuthAccessToken | The access token returned by the authorization server. |
OAuthAuthorizationCode | The authorization code that is exchanged for an access token. |
OAuthAuthorizationScope | The scope request or response parameter used during authorization. |
OAuthClientId | The id of the client assigned when registering the application. |
OAuthClientProfile | The type of client that is requesting authorization. |
OAuthClientSecret | The secret value for the client assigned when registering the application. |
OAuthGrantType | The OAuth grant type used to acquire an OAuth access token. |
OAuthRefreshToken | Specifies the refresh token received from or sent to the authorization server. |
OAuthRequestRefreshToken | Specifies whether the component will request a refresh token during authorization. |
OAuthReturnURL | The URL where the user (browser) returns after authenticating. |
OAuthServerAuthURL | The URL of the authorization server. |
OAuthServerTokenURL | The URL of the token server used to obtain the access token. |
OAuthWebAuthURL | The URL to which the user should be re-directed for authorization. |
OtherHeaders | This property includes other headers as determined by the user (optional). |
Overwrite | Determines if 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. |
Prefix | A prefix used to restrict the results returned when listing resources or shares. |
ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the component 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 Transmission Control Protocol (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 a Secure Sockets Layer (SSL) for the connection to the proxy. |
ProxyUser | This property contains a username 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. |
RangeCount | The number of records in the Range arrays. |
RangeFirst | The first byte of the range. |
RangeLast | The last byte of the range. |
ResourceData | The data that was downloaded, or that should be uploaded. |
ResourceMarker | A marker indicating what page of resources to return next. |
ResourceCount | The number of records in the Resource arrays. |
ResourceContentMD5 | An MD5 hash of the file's content. |
ResourceContentType | The content type of the resource. |
ResourceETag | The ETag of the resource. |
ResourceModifiedTime | The last modified time of the resource. |
ResourceName | The name of the resource. |
ResourcePath | The path of the resource. |
ResourceShare | The name of the share the resource resides in. |
ResourceSize | The size of the file. |
ResourceType | The resource's type. |
Share | Selects a share. |
ShareMarker | A marker indicating what page of shares to return next. |
ShareCount | The number of records in the Share arrays. |
ShareETag | The ETag of the share. |
ShareModifiedTime | The last modified time of the share. |
ShareName | The name of the share. |
ShareQuota | The share's space quota, in GB. |
ShareSpaceUsed | The amount of storage space consumed by the share. |
SSLAcceptServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLAcceptServerCertExpirationDate | This is the date the certificate expires. |
SSLAcceptServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLAcceptServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLAcceptServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLAcceptServerCertIssuer | This is the issuer of the certificate. |
SSLAcceptServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLAcceptServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLAcceptServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLAcceptServerCertPublicKey | This is the public key of the certificate. |
SSLAcceptServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLAcceptServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLAcceptServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLAcceptServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLAcceptServerCertStore | This is the name of the certificate store for the client certificate. |
SSLAcceptServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLAcceptServerCertStoreType | This is the type of certificate store for this certificate. |
SSLAcceptServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLAcceptServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLAcceptServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLAcceptServerCertUsage | This property contains the text description of UsageFlags . |
SSLAcceptServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLAcceptServerCertVersion | This property contains the certificate's version number. |
SSLAcceptServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLCertExpirationDate | This is the date the certificate expires. |
SSLCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLCertIssuer | This is the issuer of the certificate. |
SSLCertPrivateKey | This is the private key of the certificate (if available). |
SSLCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLCertPublicKey | This is the public key of the certificate. |
SSLCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
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. |
SSLCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLCertUsage | This property contains the text description of UsageFlags . |
SSLCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLCertVersion | This property contains the certificate's version number. |
SSLCertSubject | This is the subject of the certificate used for client authentication. |
SSLCertEncoded | This is the certificate (PEM/Base64 encoded). |
SSLProvider | This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. |
SSLServerCertEffectiveDate | This is the date on which this certificate becomes valid. |
SSLServerCertExpirationDate | This is the date the certificate expires. |
SSLServerCertExtendedKeyUsage | This is a comma-delimited list of extended key usage identifiers. |
SSLServerCertFingerprint | This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. |
SSLServerCertFingerprintSHA1 | This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
SSLServerCertFingerprintSHA256 | This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
SSLServerCertIssuer | This is the issuer of the certificate. |
SSLServerCertPrivateKey | This is the private key of the certificate (if available). |
SSLServerCertPrivateKeyAvailable | This property shows whether a PrivateKey is available for the selected certificate. |
SSLServerCertPrivateKeyContainer | This is the name of the PrivateKey container for the certificate (if available). |
SSLServerCertPublicKey | This is the public key of the certificate. |
SSLServerCertPublicKeyAlgorithm | This property contains the textual description of the certificate's public key algorithm. |
SSLServerCertPublicKeyLength | This is the length of the certificate's public key (in bits). |
SSLServerCertSerialNumber | This is the serial number of the certificate encoded as a string. |
SSLServerCertSignatureAlgorithm | The property contains the text description of the certificate's signature algorithm. |
SSLServerCertStore | This is the name of the certificate store for the client certificate. |
SSLServerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
SSLServerCertStoreType | This is the type of certificate store for this certificate. |
SSLServerCertSubjectAltNames | This property contains comma-separated lists of alternative subject names for the certificate. |
SSLServerCertThumbprintMD5 | This property contains the MD5 hash of the certificate. |
SSLServerCertThumbprintSHA1 | This property contains the SHA-1 hash of the certificate. |
SSLServerCertThumbprintSHA256 | This property contains the SHA-256 hash of the certificate. |
SSLServerCertUsage | This property contains the text description of UsageFlags . |
SSLServerCertUsageFlags | This property contains the flags that show intended use for the certificate. |
SSLServerCertVersion | This property contains the certificate's version number. |
SSLServerCertSubject | This is the subject of the certificate used for client authentication. |
SSLServerCertEncoded | This is the certificate (PEM/Base64 encoded). |
StartByte | The byte offset from which to start the upload or download. |
Timeout | This property includes the timeout for the component. |
UseSSL | Whether to use SSL/TLS when connecting. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AbortCopy | Aborts a copy operation. |
AddMetadata | Adds a metadata item to the Metadata properties. |
AddQueryParam | Adds a query parameter to the QueryParams properties. |
Authorize | Get the authorization string required to access the protected resource. |
ClearRange | Clears a range of bytes from a file. |
Config | Sets or retrieves a configuration setting. |
CopyFile | Copies a file. |
CreateFile | Initializes a new file. |
CreateFolder | Creates a new folder. |
CreateShare | Creates a new share. |
DelFile | Deletes a file. |
DeleteFolder | Deletes a folder. |
DeleteShare | Deletes a share. |
DownloadFile | Downloads a file. |
GetFileInfo | Gets a file's information and metadata. |
GetFolderInfo | Gets a folder's information and metadata. |
GetLink | Creates a link that provides access to a share or file. |
GetRanges | Gets the list of allocated data ranges in a file. |
GetShareInfo | Gets a share's information and metadata. |
Interrupt | This method interrupts the current method. |
ListResources | Lists resources in a given folder. |
ListShares | Lists shares in the file storage account. |
PutRange | Uploads a range of data to a file. |
RenameFile | Renames a file. |
RenameFolder | Renames a directory. |
Reset | Resets the component to its initial state. |
ResizeFile | Resizes a file. |
SetShareQuota | Sets a share's space quota. |
UpdateMetadata | Sets the metadata for a file, folder, or share. |
UploadFile | Uploads a new file resource. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
EndTransfer | This event fires when a document finishes transferring. |
Error | Fired when information is available about errors during data delivery. |
FragmentComplete | Fires after each fragment of a resumable upload is completed. |
Header | This event is fired every time a header line comes in. |
Log | This event fires once for each log message. |
Progress | Fires during an upload or download to indicate transfer progress. |
ResourceList | Fires once for each resource returned when listing resources. |
ShareList | Fires once for each share returned when listing shares. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Fired when secure connection progress messages are available. |
StartTransfer | This event fires when a document starts transferring (after the headers). |
Transfer | This event is fired while a document transfers (delivers document). |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
AccumulatePages | Whether the component should accumulate subsequent pages of results when listing them. |
APIVersion | The Azure Storage REST API version being used by the component. |
CopyId | The Id of a copy operation. |
CopyProgress | The progress of a copy operation. |
CopyStatus | The status of a copy operation. |
CopyStatusDesc | The status description for a copy operation. |
CreateShareQuota | Specifies an initial space quota to impose when creating shares. |
DeleteShareSnapshots | Whether to automatically delete share snapshots when deleting a share. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
EncryptionPasswordKDF | The KDF algorithm to use during password based encryption and decryption. |
Endpoint | The Azure Storage endpoint suffix that the component should use. |
MaxResults | The maximum number of results to return when listing resources or shares. |
ProgressAbsolute | Whether the component 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. |
SendMetadata | Whether to send metadata items when creating files and folders. |
SendMetadataOnCopy | Whether to send metadata items when copying files. |
SharedAccessSignature | Specifies a SAS token to use for authentication. |
TempPath | The path to the directory where temporary files are created. |
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 component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to True the component 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 component. |
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. |
StatusCode | The status code of the last response from the server. |
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 component. |
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. |
UseProxyAutoConfigURL | Whether to use a Proxy auto-config file when attempting a connection. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component 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 component 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 be included when performing an SSL handshake. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCheckOCSP | Whether to use OCSP to check the status of the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLClientCACerts | A newline separated list of CA certificates to use during SSL client certificate validation. |
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 cipher suite. |
SSLNegotiatedCipherStrength | Returns the negotiated cipher suite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated cipher suite. |
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 certificates 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. |
MaskSensitiveData | Whether sensitive data is masked in log messages. |
UseFIPSCompliantAPI | Tells the component whether or not to use FIPS certified APIs. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
AccessKey Property (AzureFile Component)
The Azure access key to use for authentication.
Syntax
__property String AccessKey = { read=FAccessKey, write=FSetAccessKey };
Default Value
""
Remarks
This property specifies the Azure access key that should be used for authentication. It must be set before attempting any operations which connect to the server.
Both primary and secondary access keys are valid.
This property is not available at design time.
Data Type
String
Account Property (AzureFile Component)
The Azure storage account name.
Syntax
__property String Account = { read=FAccount, write=FSetAccount };
Default Value
""
Remarks
This property specifies the name of the Azure storage account to operate against. It must be set before attempting any operations which connect to the server.
This property is not available at design time.
Data Type
String
Authorization Property (AzureFile Component)
OAuth 2.0 Authorization Token.
Syntax
__property String Authorization = { read=FAuthorization, write=FSetAuthorization };
Default Value
""
Remarks
This component supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth property, using the OAuth component or a separate process. If using the OAuth property, then the Authorization property will not be used.
Bearer ACCESS_TOKENAssign this value to the Authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.
TBD.
Data Type
String
EncryptionAlgorithm Property (AzureFile Component)
The encryption algorithm.
Syntax
__property TcsAzureFileEncryptionAlgorithms EncryptionAlgorithm = { read=FEncryptionAlgorithm, write=FSetEncryptionAlgorithm };
enum TcsAzureFileEncryptionAlgorithms { eaAES=0, eaBlowfish=1, eaCAST=2, eaDES=3, eaIDEA=4, eaRC2=5, eaRC4=6, eaTEA=7, eaTripleDES=8, eaTwofish=9, eaRijndael=10, eaChaCha=11, eaXSalsa20=12 };
Default Value
eaAES
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 (AzureFile Component)
The encryption password.
Syntax
__property String EncryptionPassword = { read=FEncryptionPassword, write=FSetEncryptionPassword };
Default Value
""
Remarks
If this property is populated when UploadFile or DownloadFile is called, the component will attempt to encrypt or decrypt the data before uploading or after downloading it.
The component uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.
However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.
This property is not available at design time.
Data Type
String
FirewallAutoDetect Property (AzureFile Component)
This property tells the component whether or not to automatically detect and use firewall system settings, if available.
Syntax
__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };
Default Value
False
Remarks
This property tells the component whether or not to automatically detect and use firewall system settings, if available.
Data Type
Boolean
FirewallType Property (AzureFile Component)
This property determines the type of firewall to connect through.
Syntax
__property TcsAzureFileFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };
enum TcsAzureFileFirewallTypes { fwNone=0, fwTunnel=1, fwSOCKS4=2, fwSOCKS5=3, fwSOCKS4A=10 };
Default Value
fwNone
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 (AzureFile Component)
This property contains the name or IP address of the firewall (optional).
Syntax
__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };
Default Value
""
Remarks
This property contains the name or IP address of the 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 component raises an exception.
Data Type
String
FirewallPassword Property (AzureFile Component)
This property contains a password if authentication is to be used when connecting through the firewall.
Syntax
__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };
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 component raises an exception.
Data Type
String
FirewallPort Property (AzureFile Component)
This property contains the Transmission Control Protocol (TCP) port for the firewall Host .
Syntax
__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };
Default Value
0
Remarks
This property contains the Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.
Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.
Data Type
Integer
FirewallUser Property (AzureFile Component)
This property contains a username if authentication is to be used when connecting through a firewall.
Syntax
__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };
Default Value
""
Remarks
This property contains a username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.
Data Type
String
Idle Property (AzureFile Component)
This property specifies the current status of the component.
Syntax
__property bool Idle = { read=FIdle };
Default Value
True
Remarks
Idle will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.
This property is read-only.
Data Type
Boolean
LocalFile Property (AzureFile Component)
The location of the local file.
Syntax
__property String LocalFile = { read=FLocalFile, write=FSetLocalFile };
Default Value
""
Remarks
This property specifies the location of a file on disk. This is used as the source file when calling UploadFile or PutRange, and as the destination file when calling DownloadFile.
Data Type
String
LocalHost Property (AzureFile Component)
This property includes the name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Syntax
__property String LocalHost = { read=FLocalHost, write=FSetLocalHost };
Default Value
""
Remarks
The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.
In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.
If the component is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).
Note: LocalHost is not persistent. You must always set it in code, and never in the property window.
Data Type
String
MetadataCount Property (AzureFile Component)
The number of records in the Metadata arrays.
Syntax
__property int MetadataCount = { read=FMetadataCount, write=FSetMetadataCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at MetadataCount - 1.This property is not available at design time.
Data Type
Integer
MetadataName Property (AzureFile Component)
The name of the metadata item.
Syntax
__property String MetadataName[int MetadataIndex] = { read=FMetadataName, write=FSetMetadataName };
Default Value
""
Remarks
The name of the metadata item.
This property specifies the name of the metadata item. Note that metadata item names are case-preserving, but not case-sensitive.
Note that the component will automatically prepend x-ms-meta- to this value when submitting metadata items to the server; and will automatically strip that prefix from this value when retrieving them from the server.
The MetadataIndex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.
This property is not available at design time.
Data Type
String
MetadataValue Property (AzureFile Component)
The value of the metadata item.
Syntax
__property String MetadataValue[int MetadataIndex] = { read=FMetadataValue, write=FSetMetadataValue };
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
OAuthAccessToken Property (AzureFile Component)
The access token returned by the authorization server.
Syntax
__property String OAuthAccessToken = { read=FOAuthAccessToken, write=FSetOAuthAccessToken };
Default Value
""
Remarks
The access token returned by the authorization server. This is set when the component makes a request to the token server.
This property is not available at design time.
Data Type
String
OAuthAuthorizationCode Property (AzureFile Component)
The authorization code that is exchanged for an access token.
Syntax
__property String OAuthAuthorizationCode = { read=FOAuthAuthorizationCode, write=FSetOAuthAuthorizationCode };
Default Value
""
Remarks
The authorization code that is exchanged for an access token. This is required to be set when the OAuthClientProfile property is set to the Web profile. Otherwise, this field is for information purposes only.
This property is not available at design time.
Data Type
String
OAuthAuthorizationScope Property (AzureFile Component)
The scope request or response parameter used during authorization.
Syntax
__property String OAuthAuthorizationScope = { read=FOAuthAuthorizationScope, write=FSetOAuthAuthorizationScope };
Default Value
""
Remarks
The scope request or response parameter used during authorization.
This property is not available at design time.
Data Type
String
OAuthClientId Property (AzureFile Component)
The id of the client assigned when registering the application.
Syntax
__property String OAuthClientId = { read=FOAuthClientId, write=FSetOAuthClientId };
Default Value
""
Remarks
The id of the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthClientProfile Property (AzureFile Component)
The type of client that is requesting authorization.
Syntax
__property TcsAzureFileOAuthClientProfiles OAuthClientProfile = { read=FOAuthClientProfile, write=FSetOAuthClientProfile };
enum TcsAzureFileOAuthClientProfiles { cocpApplication=0, cocpWeb=1 };
Default Value
cocpApplication
Remarks
The type of client that is requesting authorization. See the introduction section for more information. Possible values are:
0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. |
1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. |
This property is not available at design time.
Data Type
Integer
OAuthClientSecret Property (AzureFile Component)
The secret value for the client assigned when registering the application.
Syntax
__property String OAuthClientSecret = { read=FOAuthClientSecret, write=FSetOAuthClientSecret };
Default Value
""
Remarks
The secret value for the client assigned when registering the application.
This property is not available at design time.
Data Type
String
OAuthGrantType Property (AzureFile Component)
The OAuth grant type used to acquire an OAuth access token.
Syntax
__property TcsAzureFileOAuthGrantTypes OAuthGrantType = { read=FOAuthGrantType, write=FSetOAuthGrantType };
enum TcsAzureFileOAuthGrantTypes { cogtAuthorizationCode=0, cogtImplicit=1, cogtPassword=2, cogtClientCredentials=3 };
Default Value
cogtAuthorizationCode
Remarks
The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:
0 (cogtAuthorizationCode - Default) | Authorization Code grant type |
1 (cogtImplicit) | Implicit grant type |
2 (cogtPassword) | Resource Owner Password Credentials grant type |
3 (cogtClientCredentials) | Client Credentials grant type |
This property is not available at design time.
Data Type
Integer
OAuthRefreshToken Property (AzureFile Component)
Specifies the refresh token received from or sent to the authorization server.
Syntax
__property String OAuthRefreshToken = { read=FOAuthRefreshToken, write=FSetOAuthRefreshToken };
Default Value
""
Remarks
Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the OAuthGrantType property is set to a grant that can use refresh tokens.
This property is not available at design time.
Data Type
String
OAuthRequestRefreshToken Property (AzureFile Component)
Specifies whether the component will request a refresh token during authorization.
Syntax
__property bool OAuthRequestRefreshToken = { read=FOAuthRequestRefreshToken, write=FSetOAuthRequestRefreshToken };
Default Value
true
Remarks
Specifies whether the component will request a refresh token during authorization. By default, this value is True.
When True, the component will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.
Note: This property is only applicable when the OAuthGrantType property is set to cogtAuthorizationCode.
This property is not available at design time.
Data Type
Boolean
OAuthReturnURL Property (AzureFile Component)
The URL where the user (browser) returns after authenticating.
Syntax
__property String OAuthReturnURL = { read=FOAuthReturnURL, write=FSetOAuthReturnURL };
Default Value
""
Remarks
The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the component when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.
This property is not available at design time.
Data Type
String
OAuthServerAuthURL Property (AzureFile Component)
The URL of the authorization server.
Syntax
__property String OAuthServerAuthURL = { read=FOAuthServerAuthURL, write=FSetOAuthServerAuthURL };
Default Value
""
Remarks
The URL of the authorization server.
This property is not available at design time.
Data Type
String
OAuthServerTokenURL Property (AzureFile Component)
The URL of the token server used to obtain the access token.
Syntax
__property String OAuthServerTokenURL = { read=FOAuthServerTokenURL, write=FSetOAuthServerTokenURL };
Default Value
""
Remarks
The URL of the token server used to obtain the access token.
This property is not available at design time.
Data Type
String
OAuthWebAuthURL Property (AzureFile Component)
The URL to which the user should be re-directed for authorization.
Syntax
__property String OAuthWebAuthURL = { read=FOAuthWebAuthURL };
Default Value
""
Remarks
The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.
This property is read-only and not available at design time.
Data Type
String
OtherHeaders Property (AzureFile Component)
This property includes other headers as determined by the user (optional).
Syntax
__property String OtherHeaders = { read=FOtherHeaders, write=FSetOtherHeaders };
Default Value
""
Remarks
This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.
The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this property with caution. If this property contains invalid headers, HTTP requests may fail.
This property is useful for extending the functionality of the component beyond what is provided.
This property is not available at design time.
Data Type
String
Overwrite Property (AzureFile Component)
Determines if files are overwritten.
Syntax
__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };
Default Value
false
Remarks
This property controls whether local files are overwritten when calling DownloadFile or remote files are renamed when calling RenameFile. The default value is false.
Data Type
Boolean
ParsedHeaderCount Property (AzureFile Component)
The number of records in the ParsedHeader arrays.
Syntax
__property int ParsedHeaderCount = { read=FParsedHeaderCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ParsedHeaderCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ParsedHeaderField Property (AzureFile Component)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
__property String ParsedHeaderField[int ParsedHeaderIndex] = { read=FParsedHeaderField };
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
ParsedHeaderValue Property (AzureFile Component)
This property contains the header contents.
Syntax
__property String ParsedHeaderValue[int ParsedHeaderIndex] = { read=FParsedHeaderValue };
Default Value
""
Remarks
This property contains the Header contents.
The ParsedHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.
This property is read-only and not available at design time.
Data Type
String
Prefix Property (AzureFile Component)
A prefix used to restrict the results returned when listing resources or shares.
Syntax
__property String Prefix = { read=FPrefix, write=FSetPrefix };
Default Value
""
Remarks
This property, if non-empty, is used to restrict the results returned by ListResources or ListShares to only the items whose names begin with the given value.
This property is not available at design time.
Data Type
String
ProxyAuthScheme Property (AzureFile Component)
This property is used to tell the component which type of authorization to perform when connecting to the proxy.
Syntax
__property TcsAzureFileProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };
enum TcsAzureFileProxyAuthSchemes { authBasic=0, authDigest=1, authProprietary=2, authNone=3, authNtlm=4, authNegotiate=5 };
Default Value
authBasic
Remarks
This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.
ProxyAuthScheme should be set to authNone (3) when no authentication is expected.
By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.
If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.
If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.
If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.
For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.
Data Type
Integer
ProxyAutoDetect Property (AzureFile Component)
This property tells the component whether or not to automatically detect and use proxy system settings, if available.
Syntax
__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };
Default Value
False
Remarks
This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.
Data Type
Boolean
ProxyPassword Property (AzureFile Component)
This property contains a password if authentication is to be used for the proxy.
Syntax
__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };
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 properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
ProxyPort Property (AzureFile Component)
This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
Syntax
__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };
Default Value
80
Remarks
This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.
Data Type
Integer
ProxyServer Property (AzureFile Component)
If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
Syntax
__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };
Default Value
""
Remarks
If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.
Data Type
String
ProxySSL Property (AzureFile Component)
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
Syntax
__property TcsAzureFileProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };
enum TcsAzureFileProxySSLs { psAutomatic=0, psAlways=1, psNever=2, psTunnel=3 };
Default Value
psAutomatic
Remarks
This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:
psAutomatic (0) | Default setting. If the URL is an https URL, the component will use the psTunnel option. If the URL is an http URL, the component will use the psNever option. |
psAlways (1) | The connection is always SSL-enabled. |
psNever (2) | The connection is not SSL-enabled. |
psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. |
Data Type
Integer
ProxyUser Property (AzureFile Component)
This property contains a username if authentication is to be used for the proxy.
Syntax
__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };
Default Value
""
Remarks
This property contains a username if authentication is to be used for the proxy.
If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].
If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.
If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.
Data Type
String
QueryParamCount Property (AzureFile Component)
The number of records in the QueryParam arrays.
Syntax
__property int QueryParamCount = { read=FQueryParamCount, write=FSetQueryParamCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at QueryParamCount - 1.This property is not available at design time.
Data Type
Integer
QueryParamName Property (AzureFile Component)
The name of the query parameter.
Syntax
__property String QueryParamName[int QueryParamIndex] = { read=FQueryParamName, write=FSetQueryParamName };
Default Value
""
Remarks
The name of the query parameter.
This property specifies the name of the query parameter.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
QueryParamValue Property (AzureFile Component)
The value of the query parameter.
Syntax
__property String QueryParamValue[int QueryParamIndex] = { read=FQueryParamValue, write=FSetQueryParamValue };
Default Value
""
Remarks
The value of the query parameter.
This property specifies the value of the query parameter. The component will automatically URL-encode this value when sending the request.
The QueryParamIndex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.
This property is not available at design time.
Data Type
String
RangeCount Property (AzureFile Component)
The number of records in the Range arrays.
Syntax
__property int RangeCount = { read=FRangeCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at RangeCount - 1.This property is read-only and not available at design time.
Data Type
Integer
RangeFirst Property (AzureFile Component)
The first byte of the range.
Syntax
__property __int64 RangeFirst[int RangeIndex] = { read=FRangeFirst };
Default Value
0
Remarks
The first byte of the range.
This property specifies the first byte (inclusive) of the byte range.
The RangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.
This property is read-only and not available at design time.
Data Type
Long64
RangeLast Property (AzureFile Component)
The last byte of the range.
Syntax
__property __int64 RangeLast[int RangeIndex] = { read=FRangeLast };
Default Value
0
Remarks
The last byte of the range.
This property specifies the last byte (inclusive) of the byte range.
The RangeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RangeCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceData Property (AzureFile Component)
The data that was downloaded, or that should be uploaded.
Syntax
__property String ResourceData = { read=FResourceData, write=FSetResourceData }; __property DynamicArray<Byte> ResourceDataB = { read=FResourceDataB, write=FSetResourceDataB };
Default Value
""
Remarks
This property is populated with file data after calling DownloadFile if LocalFile is not set.
This property can also be set before calling UploadFile; its data will be uploaded if LocalFile is not set.
This property is not available at design time.
Data Type
Byte Array
ResourceMarker Property (AzureFile Component)
A marker indicating what page of resources to return next.
Syntax
__property String ResourceMarker = { read=FResourceMarker, write=FSetResourceMarker };
Default Value
""
Remarks
This property will be populated when ListResources is called if the results are paged and there are more pages. To list all resources, continue to call ListResources until this property returns empty string.
Refer to ListResources for more information.
This property is not available at design time.
Data Type
String
ResourceCount Property (AzureFile Component)
The number of records in the Resource arrays.
Syntax
__property int ResourceCount = { read=FResourceCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- ResourceContentMD5
- ResourceContentType
- ResourceETag
- ResourceModifiedTime
- ResourceName
- ResourcePath
- ResourceShare
- ResourceSize
- ResourceType
This property is read-only and not available at design time.
Data Type
Integer
ResourceContentMD5 Property (AzureFile Component)
An MD5 hash of the file's content.
Syntax
__property String ResourceContentMD5[int ResourceIndex] = { read=FResourceContentMD5 };
Default Value
""
Remarks
An MD5 hash of the file's content.
This property reflects the MD5 hash of the file's content, if one is returned by the server. Always empty for folders.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceContentType Property (AzureFile Component)
The content type of the resource.
Syntax
__property String ResourceContentType[int ResourceIndex] = { read=FResourceContentType };
Default Value
""
Remarks
The content type of the resource.
This property reflects the content type of the resource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceETag Property (AzureFile Component)
The ETag of the resource.
Syntax
__property String ResourceETag[int ResourceIndex] = { read=FResourceETag };
Default Value
""
Remarks
The ETag of the resource.
This property reflects the ETag of the resource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceModifiedTime Property (AzureFile Component)
The last modified time of the resource.
Syntax
__property String ResourceModifiedTime[int ResourceIndex] = { read=FResourceModifiedTime };
Default Value
""
Remarks
The last modified time of the resource.
This property reflects the last modified time of the resource, formatted according to RFC 1233.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceName Property (AzureFile Component)
The name of the resource.
Syntax
__property String ResourceName[int ResourceIndex] = { read=FResourceName };
Default Value
""
Remarks
The name of the resource.
This property reflects the name of the resource.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourcePath Property (AzureFile Component)
The path of the resource.
Syntax
__property String ResourcePath[int ResourceIndex] = { read=FResourcePath };
Default Value
""
Remarks
The path of the resource.
This property reflects the path of the resource (not including the name of the share it resides in; see ResourceShare).
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceShare Property (AzureFile Component)
The name of the share the resource resides in.
Syntax
__property String ResourceShare[int ResourceIndex] = { read=FResourceShare };
Default Value
""
Remarks
The name of the share the resource resides in.
This property reflects the name of the share the resource resides in.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
String
ResourceSize Property (AzureFile Component)
The size of the file.
Syntax
__property __int64 ResourceSize[int ResourceIndex] = { read=FResourceSize };
Default Value
0
Remarks
The size of the file.
This property reflects the size, in bytes, of the file resource. Always 0 for folders.
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Long64
ResourceType Property (AzureFile Component)
The resource's type.
Syntax
__property TcsAzureFileResourceTypes ResourceType[int ResourceIndex] = { read=FResourceType };
enum TcsAzureFileResourceTypes { afrtFile=0, afrtFolder=1 };
Default Value
afrtFile
Remarks
The resource's type.
This property indicates whether the resource is a folder or a file. Possible values are:
0 (afrtFile) | A file. |
1 (afrtFolder) | A folder. |
The ResourceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ResourceCount property.
This property is read-only and not available at design time.
Data Type
Integer
Share Property (AzureFile Component)
Selects a share.
Syntax
__property String Share = { read=FShare, write=FSetShare };
Default Value
""
Remarks
This property selects a share, by name, for the component to operate against. It must be set before attempting most operations.
Share Name Rules
Share names must adhere to the following rules:
- Must be 3 to 63 characters long.
- Must start with a letter or number; and may only contain letters, numbers, and hyphens.
- All letters much be lowercase. (For convenience, the component will automatically lowercase all letters in any value assigned to Share.)
- All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).
This property is not available at design time.
Data Type
String
ShareMarker Property (AzureFile Component)
A marker indicating what page of shares to return next.
Syntax
__property String ShareMarker = { read=FShareMarker, write=FSetShareMarker };
Default Value
""
Remarks
This property will be populated when ListShares is called if the results are paged and there are more pages. To list all shares, continue to call ListShares until this property returns empty string.
Refer to ListShares for more information.
This property is not available at design time.
Data Type
String
ShareCount Property (AzureFile Component)
The number of records in the Share arrays.
Syntax
__property int ShareCount = { read=FShareCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at ShareCount - 1.This property is read-only and not available at design time.
Data Type
Integer
ShareETag Property (AzureFile Component)
The ETag of the share.
Syntax
__property String ShareETag[int ShareIndex] = { read=FShareETag };
Default Value
""
Remarks
The ETag of the share.
This property reflects the ETag of the share.
The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.
This property is read-only and not available at design time.
Data Type
String
ShareModifiedTime Property (AzureFile Component)
The last modified time of the share.
Syntax
__property String ShareModifiedTime[int ShareIndex] = { read=FShareModifiedTime };
Default Value
""
Remarks
The last modified time of the share.
This property reflects the last modified time of the share, formatted according to RFC 1123.
Note that the share's last modified time is not updated by operations against resources within the share.
The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.
This property is read-only and not available at design time.
Data Type
String
ShareName Property (AzureFile Component)
The name of the share.
Syntax
__property String ShareName[int ShareIndex] = { read=FShareName };
Default Value
""
Remarks
The name of the share.
This property reflects the name of the share.
The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.
This property is read-only and not available at design time.
Data Type
String
ShareQuota Property (AzureFile Component)
The share's space quota, in GB.
Syntax
__property int ShareQuota[int ShareIndex] = { read=FShareQuota };
Default Value
0
Remarks
The share's space quota, in GB.
This property reflects the space quota, in GB, imposed on the share.
The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.
This property is read-only and not available at design time.
Data Type
Integer
ShareSpaceUsed Property (AzureFile Component)
The amount of storage space consumed by the share.
Syntax
__property int ShareSpaceUsed[int ShareIndex] = { read=FShareSpaceUsed };
Default Value
0
Remarks
The amount of storage space consumed by the share.
This property reflects the approximate amount of storage space, in GB, the share is consuming.
The ShareIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ShareCount property.
This property is read-only and not available at design time.
Data Type
Integer
SSLAcceptServerCertEffectiveDate Property (AzureFile Component)
This is the date on which this certificate becomes valid.
Syntax
__property String SSLAcceptServerCertEffectiveDate = { read=FSSLAcceptServerCertEffectiveDate };
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExpirationDate Property (AzureFile Component)
This is the date the certificate expires.
Syntax
__property String SSLAcceptServerCertExpirationDate = { read=FSSLAcceptServerCertExpirationDate };
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLAcceptServerCertExtendedKeyUsage Property (AzureFile Component)
This is a comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLAcceptServerCertExtendedKeyUsage = { read=FSSLAcceptServerCertExtendedKeyUsage };
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprint Property (AzureFile Component)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprint = { read=FSSLAcceptServerCertFingerprint };
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA1 Property (AzureFile Component)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA1 = { read=FSSLAcceptServerCertFingerprintSHA1 };
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLAcceptServerCertFingerprintSHA256 Property (AzureFile Component)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLAcceptServerCertFingerprintSHA256 = { read=FSSLAcceptServerCertFingerprintSHA256 };
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLAcceptServerCertIssuer Property (AzureFile Component)
This is the issuer of the certificate.
Syntax
__property String SSLAcceptServerCertIssuer = { read=FSSLAcceptServerCertIssuer };
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKey Property (AzureFile Component)
This is the private key of the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKey = { read=FSSLAcceptServerCertPrivateKey };
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLAcceptServerCertPrivateKeyAvailable Property (AzureFile Component)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLAcceptServerCertPrivateKeyAvailable = { read=FSSLAcceptServerCertPrivateKeyAvailable };
Default Value
false
Remarks
This property shows whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLAcceptServerCertPrivateKeyContainer Property (AzureFile Component)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLAcceptServerCertPrivateKeyContainer = { read=FSSLAcceptServerCertPrivateKeyContainer };
Default Value
""
Remarks
This is the name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKey Property (AzureFile Component)
This is the public key of the certificate.
Syntax
__property String SSLAcceptServerCertPublicKey = { read=FSSLAcceptServerCertPublicKey };
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyAlgorithm Property (AzureFile Component)
This property contains the textual description of the certificate's public key algorithm.
Syntax
__property String SSLAcceptServerCertPublicKeyAlgorithm = { read=FSSLAcceptServerCertPublicKeyAlgorithm };
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertPublicKeyLength Property (AzureFile Component)
This is the length of the certificate's public key (in bits).
Syntax
__property int SSLAcceptServerCertPublicKeyLength = { read=FSSLAcceptServerCertPublicKeyLength };
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertSerialNumber Property (AzureFile Component)
This is the serial number of the certificate encoded as a string.
Syntax
__property String SSLAcceptServerCertSerialNumber = { read=FSSLAcceptServerCertSerialNumber };
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLAcceptServerCertSignatureAlgorithm Property (AzureFile Component)
The property contains the text description of the certificate's signature algorithm.
Syntax
__property String SSLAcceptServerCertSignatureAlgorithm = { read=FSSLAcceptServerCertSignatureAlgorithm };
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLAcceptServerCertStore Property (AzureFile Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSLAcceptServerCertStore = { read=FSSLAcceptServerCertStore, write=FSetSSLAcceptServerCertStore }; __property DynamicArray<Byte> SSLAcceptServerCertStoreB = { read=FSSLAcceptServerCertStoreB, write=FSetSSLAcceptServerCertStoreB };
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.
SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are 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., PKCS#12 certificate store).
Data Type
Byte Array
SSLAcceptServerCertStorePassword Property (AzureFile Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLAcceptServerCertStorePassword = { read=FSSLAcceptServerCertStorePassword, write=FSetSSLAcceptServerCertStorePassword };
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
SSLAcceptServerCertStoreType Property (AzureFile Component)
This is the type of certificate store for this certificate.
Syntax
__property TcsAzureFileSSLAcceptServerCertStoreTypes SSLAcceptServerCertStoreType = { read=FSSLAcceptServerCertStoreType, write=FSetSSLAcceptServerCertStoreType };
enum TcsAzureFileSSLAcceptServerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLAcceptServerCertStore and set SSLAcceptServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
SSLAcceptServerCertSubjectAltNames Property (AzureFile Component)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLAcceptServerCertSubjectAltNames = { read=FSSLAcceptServerCertSubjectAltNames };
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintMD5 Property (AzureFile Component)
This property contains the MD5 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintMD5 = { read=FSSLAcceptServerCertThumbprintMD5 };
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA1 Property (AzureFile Component)
This property contains the SHA-1 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA1 = { read=FSSLAcceptServerCertThumbprintSHA1 };
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertThumbprintSHA256 Property (AzureFile Component)
This property contains the SHA-256 hash of the certificate.
Syntax
__property String SSLAcceptServerCertThumbprintSHA256 = { read=FSSLAcceptServerCertThumbprintSHA256 };
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsage Property (AzureFile Component)
This property contains the text description of UsageFlags .
Syntax
__property String SSLAcceptServerCertUsage = { read=FSSLAcceptServerCertUsage };
Default Value
""
Remarks
This property contains the text description of SSLAcceptServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLAcceptServerCertUsageFlags Property (AzureFile Component)
This property contains the flags that show intended use for the certificate.
Syntax
__property int SSLAcceptServerCertUsageFlags = { read=FSSLAcceptServerCertUsageFlags };
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLAcceptServerCertVersion Property (AzureFile Component)
This property contains the certificate's version number.
Syntax
__property String SSLAcceptServerCertVersion = { read=FSSLAcceptServerCertVersion };
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLAcceptServerCertSubject Property (AzureFile Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSLAcceptServerCertSubject = { read=FSSLAcceptServerCertSubject, write=FSetSSLAcceptServerCertSubject };
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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
SSLAcceptServerCertEncoded Property (AzureFile Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded }; __property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };
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
SSLCertEffectiveDate Property (AzureFile Component)
This is the date on which this certificate becomes valid.
Syntax
__property String SSLCertEffectiveDate = { read=FSSLCertEffectiveDate };
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLCertExpirationDate Property (AzureFile Component)
This is the date the certificate expires.
Syntax
__property String SSLCertExpirationDate = { read=FSSLCertExpirationDate };
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLCertExtendedKeyUsage Property (AzureFile Component)
This is a comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLCertExtendedKeyUsage = { read=FSSLCertExtendedKeyUsage };
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLCertFingerprint Property (AzureFile Component)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprint = { read=FSSLCertFingerprint };
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLCertFingerprintSHA1 Property (AzureFile Component)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA1 = { read=FSSLCertFingerprintSHA1 };
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLCertFingerprintSHA256 Property (AzureFile Component)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLCertFingerprintSHA256 = { read=FSSLCertFingerprintSHA256 };
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLCertIssuer Property (AzureFile Component)
This is the issuer of the certificate.
Syntax
__property String SSLCertIssuer = { read=FSSLCertIssuer };
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLCertPrivateKey Property (AzureFile Component)
This is the private key of the certificate (if available).
Syntax
__property String SSLCertPrivateKey = { read=FSSLCertPrivateKey };
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLCertPrivateKeyAvailable Property (AzureFile Component)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLCertPrivateKeyAvailable = { read=FSSLCertPrivateKeyAvailable };
Default Value
false
Remarks
This property shows whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLCertPrivateKeyContainer Property (AzureFile Component)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLCertPrivateKeyContainer = { read=FSSLCertPrivateKeyContainer };
Default Value
""
Remarks
This is the name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLCertPublicKey Property (AzureFile Component)
This is the public key of the certificate.
Syntax
__property String SSLCertPublicKey = { read=FSSLCertPublicKey };
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLCertPublicKeyAlgorithm Property (AzureFile Component)
This property contains the textual description of the certificate's public key algorithm.
Syntax
__property String SSLCertPublicKeyAlgorithm = { read=FSSLCertPublicKeyAlgorithm };
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertPublicKeyLength Property (AzureFile Component)
This is the length of the certificate's public key (in bits).
Syntax
__property int SSLCertPublicKeyLength = { read=FSSLCertPublicKeyLength };
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLCertSerialNumber Property (AzureFile Component)
This is the serial number of the certificate encoded as a string.
Syntax
__property String SSLCertSerialNumber = { read=FSSLCertSerialNumber };
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLCertSignatureAlgorithm Property (AzureFile Component)
The property contains the text description of the certificate's signature algorithm.
Syntax
__property String SSLCertSignatureAlgorithm = { read=FSSLCertSignatureAlgorithm };
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLCertStore Property (AzureFile Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore }; __property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.
SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
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., PKCS#12 certificate store).
Data Type
Byte Array
SSLCertStorePassword Property (AzureFile Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
String
SSLCertStoreType Property (AzureFile Component)
This is the type of certificate store for this certificate.
Syntax
__property TcsAzureFileSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };
enum TcsAzureFileSSLCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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
SSLCertSubjectAltNames Property (AzureFile Component)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLCertSubjectAltNames = { read=FSSLCertSubjectAltNames };
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLCertThumbprintMD5 Property (AzureFile Component)
This property contains the MD5 hash of the certificate.
Syntax
__property String SSLCertThumbprintMD5 = { read=FSSLCertThumbprintMD5 };
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA1 Property (AzureFile Component)
This property contains the SHA-1 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA1 = { read=FSSLCertThumbprintSHA1 };
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertThumbprintSHA256 Property (AzureFile Component)
This property contains the SHA-256 hash of the certificate.
Syntax
__property String SSLCertThumbprintSHA256 = { read=FSSLCertThumbprintSHA256 };
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLCertUsage Property (AzureFile Component)
This property contains the text description of UsageFlags .
Syntax
__property String SSLCertUsage = { read=FSSLCertUsage };
Default Value
""
Remarks
This property contains the text description of SSLCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLCertUsageFlags Property (AzureFile Component)
This property contains the flags that show intended use for the certificate.
Syntax
__property int SSLCertUsageFlags = { read=FSSLCertUsageFlags };
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLCertVersion Property (AzureFile Component)
This property contains the certificate's version number.
Syntax
__property String SSLCertVersion = { read=FSSLCertVersion };
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLCertSubject Property (AzureFile Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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
SSLCertEncoded Property (AzureFile Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded }; __property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };
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
SSLProvider Property (AzureFile Component)
This property specifies the Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
Syntax
__property TcsAzureFileSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };
enum TcsAzureFileSSLProviders { sslpAutomatic=0, sslpPlatform=1, sslpInternal=2 };
Default Value
sslpAutomatic
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 component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.
Possible values are as follows:
0 (sslpAutomatic - default) | Automatically selects the appropriate implementation. |
1 (sslpPlatform) | Uses the platform/system implementation. |
2 (sslpInternal) | Uses the internal implementation. |
In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.
When Automatic is selected, the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used.
Data Type
Integer
SSLServerCertEffectiveDate Property (AzureFile Component)
This is the date on which this certificate becomes valid.
Syntax
__property String SSLServerCertEffectiveDate = { read=FSSLServerCertEffectiveDate };
Default Value
""
Remarks
This is the date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExpirationDate Property (AzureFile Component)
This is the date the certificate expires.
Syntax
__property String SSLServerCertExpirationDate = { read=FSSLServerCertExpirationDate };
Default Value
""
Remarks
This is the date the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
String
SSLServerCertExtendedKeyUsage Property (AzureFile Component)
This is a comma-delimited list of extended key usage identifiers.
Syntax
__property String SSLServerCertExtendedKeyUsage = { read=FSSLServerCertExtendedKeyUsage };
Default Value
""
Remarks
This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
String
SSLServerCertFingerprint Property (AzureFile Component)
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprint = { read=FSSLServerCertFingerprint };
Default Value
""
Remarks
This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA1 Property (AzureFile Component)
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprintSHA1 = { read=FSSLServerCertFingerprintSHA1 };
Default Value
""
Remarks
This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
String
SSLServerCertFingerprintSHA256 Property (AzureFile Component)
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
__property String SSLServerCertFingerprintSHA256 = { read=FSSLServerCertFingerprintSHA256 };
Default Value
""
Remarks
This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
String
SSLServerCertIssuer Property (AzureFile Component)
This is the issuer of the certificate.
Syntax
__property String SSLServerCertIssuer = { read=FSSLServerCertIssuer };
Default Value
""
Remarks
This is the issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
String
SSLServerCertPrivateKey Property (AzureFile Component)
This is the private key of the certificate (if available).
Syntax
__property String SSLServerCertPrivateKey = { read=FSSLServerCertPrivateKey };
Default Value
""
Remarks
This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
String
SSLServerCertPrivateKeyAvailable Property (AzureFile Component)
This property shows whether a PrivateKey is available for the selected certificate.
Syntax
__property bool SSLServerCertPrivateKeyAvailable = { read=FSSLServerCertPrivateKeyAvailable };
Default Value
false
Remarks
This property shows whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
Boolean
SSLServerCertPrivateKeyContainer Property (AzureFile Component)
This is the name of the PrivateKey container for the certificate (if available).
Syntax
__property String SSLServerCertPrivateKeyContainer = { read=FSSLServerCertPrivateKeyContainer };
Default Value
""
Remarks
This is the name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
String
SSLServerCertPublicKey Property (AzureFile Component)
This is the public key of the certificate.
Syntax
__property String SSLServerCertPublicKey = { read=FSSLServerCertPublicKey };
Default Value
""
Remarks
This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyAlgorithm Property (AzureFile Component)
This property contains the textual description of the certificate's public key algorithm.
Syntax
__property String SSLServerCertPublicKeyAlgorithm = { read=FSSLServerCertPublicKeyAlgorithm };
Default Value
""
Remarks
This property contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertPublicKeyLength Property (AzureFile Component)
This is the length of the certificate's public key (in bits).
Syntax
__property int SSLServerCertPublicKeyLength = { read=FSSLServerCertPublicKeyLength };
Default Value
0
Remarks
This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
Integer
SSLServerCertSerialNumber Property (AzureFile Component)
This is the serial number of the certificate encoded as a string.
Syntax
__property String SSLServerCertSerialNumber = { read=FSSLServerCertSerialNumber };
Default Value
""
Remarks
This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
String
SSLServerCertSignatureAlgorithm Property (AzureFile Component)
The property contains the text description of the certificate's signature algorithm.
Syntax
__property String SSLServerCertSignatureAlgorithm = { read=FSSLServerCertSignatureAlgorithm };
Default Value
""
Remarks
The property contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
String
SSLServerCertStore Property (AzureFile Component)
This is the name of the certificate store for the client certificate.
Syntax
__property String SSLServerCertStore = { read=FSSLServerCertStore }; __property DynamicArray<Byte> SSLServerCertStoreB = { read=FSSLServerCertStoreB };
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password protected, specify the password in SSLServerCertStorePassword.
SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are 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., PKCS#12 certificate store).
This property is read-only.
Data Type
Byte Array
SSLServerCertStorePassword Property (AzureFile Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
__property String SSLServerCertStorePassword = { read=FSSLServerCertStorePassword };
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.
This property is read-only.
Data Type
String
SSLServerCertStoreType Property (AzureFile Component)
This is the type of certificate store for this certificate.
Syntax
__property TcsAzureFileSSLServerCertStoreTypes SSLServerCertStoreType = { read=FSSLServerCertStoreType };
enum TcsAzureFileSSLServerCertStoreTypes { cstUser=0, cstMachine=1, cstPFXFile=2, cstPFXBlob=3, cstJKSFile=4, cstJKSBlob=5, cstPEMKeyFile=6, cstPEMKeyBlob=7, cstPublicKeyFile=8, cstPublicKeyBlob=9, cstSSHPublicKeyBlob=10, cstP7BFile=11, cstP7BBlob=12, cstSSHPublicKeyFile=13, cstPPKFile=14, cstPPKBlob=15, cstXMLFile=16, cstXMLBlob=17, cstJWKFile=18, cstJWKBlob=19, cstSecurityKey=20, cstBCFKSFile=21, cstBCFKSBlob=22, cstPKCS11=23, cstAuto=99 };
Default Value
cstUser
Remarks
This is the type of certificate store for this certificate.
The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
Note: This store type is only available in Java. |
5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
Note: this store type is only available in Java. |
6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
Note: This store type is only available in Java and .NET. |
22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
Note: This store type is only available in Java and .NET. |
23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr component. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLServerCertStore and set SSLServerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key:
|
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. |
This property is read-only.
Data Type
Integer
SSLServerCertSubjectAltNames Property (AzureFile Component)
This property contains comma-separated lists of alternative subject names for the certificate.
Syntax
__property String SSLServerCertSubjectAltNames = { read=FSSLServerCertSubjectAltNames };
Default Value
""
Remarks
This property contains comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
String
SSLServerCertThumbprintMD5 Property (AzureFile Component)
This property contains the MD5 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintMD5 = { read=FSSLServerCertThumbprintMD5 };
Default Value
""
Remarks
This property contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA1 Property (AzureFile Component)
This property contains the SHA-1 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintSHA1 = { read=FSSLServerCertThumbprintSHA1 };
Default Value
""
Remarks
This property contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertThumbprintSHA256 Property (AzureFile Component)
This property contains the SHA-256 hash of the certificate.
Syntax
__property String SSLServerCertThumbprintSHA256 = { read=FSSLServerCertThumbprintSHA256 };
Default Value
""
Remarks
This property contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
String
SSLServerCertUsage Property (AzureFile Component)
This property contains the text description of UsageFlags .
Syntax
__property String SSLServerCertUsage = { read=FSSLServerCertUsage };
Default Value
""
Remarks
This property contains the text description of SSLServerCertUsageFlags.
This value will be of one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
String
SSLServerCertUsageFlags Property (AzureFile Component)
This property contains the flags that show intended use for the certificate.
Syntax
__property int SSLServerCertUsageFlags = { read=FSSLServerCertUsageFlags };
Default Value
0
Remarks
This property contains the flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:
0x80 | Digital Signature |
0x40 | Non-Repudiation |
0x20 | Key Encipherment |
0x10 | Data Encipherment |
0x08 | Key Agreement |
0x04 | Certificate Signing |
0x02 | CRL Signing |
0x01 | Encipher Only |
Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
Integer
SSLServerCertVersion Property (AzureFile Component)
This property contains the certificate's version number.
Syntax
__property String SSLServerCertVersion = { read=FSSLServerCertVersion };
Default Value
""
Remarks
This property contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
String
SSLServerCertSubject Property (AzureFile Component)
This is the subject of the certificate used for client authentication.
Syntax
__property String SSLServerCertSubject = { read=FSSLServerCertSubject };
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname 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.
This property is read-only.
Data Type
String
SSLServerCertEncoded Property (AzureFile Component)
This is the certificate (PEM/Base64 encoded).
Syntax
__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded }; __property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };
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 (AzureFile Component)
The byte offset from which to start the upload or download.
Syntax
__property __int64 StartByte = { read=FStartByte, write=FSetStartByte };
Default Value
0
Remarks
This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See UploadFile and DownloadFile for details about resuming uploads and downloads.
This property is not available at design time.
Data Type
Long64
Timeout Property (AzureFile Component)
This property includes the timeout for the component.
Syntax
__property int Timeout = { read=FTimeout, write=FSetTimeout };
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 component will wait for the operation to complete before returning control.
The component 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 component raises an exception.
Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.
The default value for the Timeout property is 60 seconds.
Data Type
Integer
UseSSL Property (AzureFile Component)
Whether to use SSL/TLS when connecting.
Syntax
__property bool UseSSL = { read=FUseSSL, write=FSetUseSSL };
Default Value
true
Remarks
This property specifies whether the component should use SSL/TLS when connecting.
This property is not available at design time.
Data Type
Boolean
AbortCopy Method (AzureFile Component)
Aborts a copy operation.
Syntax
void __fastcall AbortCopy(String DestFilePath, String CopyId);
Remarks
This method aborts the copy operation identified by the given CopyId for the destination file at DestFilePath in the share currently selected by Share.
Note that the destination file will still exist after aborting a copy operation, but it will be empty.
AddMetadata Method (AzureFile Component)
Adds a metadata item to the Metadata properties.
Syntax
void __fastcall AddMetadata(String Name, String Value);
Remarks
This method adds a metadata item to the Metadata properties. Name specifies the name of the item, and Value specifies the value of the item.
Note that the component will automatically prepend x-ms-meta- to metadata item names (as necessary) when they are submitted to the server. Also note that while metadata item names are case-preserving, they are not case-sensitive.
AddQueryParam Method (AzureFile Component)
Adds a query parameter to the QueryParams properties.
Syntax
void __fastcall AddQueryParam(String Name, String Value);
Remarks
This method is used to add a query parameter to the QueryParams properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.
All specified Values will be URL encoded by the component automatically. Consult the service documentation for details on the available parameters.
Authorize Method (AzureFile Component)
Get the authorization string required to access the protected resource.
Syntax
void __fastcall Authorize();
Remarks
This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the OAuthClientProfile property and the OAuthGrantType property. This method is not to be used in conjunction with the Authorization property. It should instead be used when setting the OAuth property.
For more information, see the introduction section.
ClearRange Method (AzureFile Component)
Clears a range of bytes from a file.
Syntax
void __fastcall ClearRange(String FilePath, __int64 First, __int64 Last);
Remarks
This method clears the range of bytes from First to Last (inclusive) from the file at FilePath in the share currently selected by Share.
The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file. When this method is called, the server frees any such chunks that are completely covered by the specified range of bytes ([First]-[Last]), and writes 0s to the appropriate portions of any chunks which are not completely covered by that range.
Freed chunks are not included in the results returned by GetRanges.
Config Method (AzureFile Component)
Sets or retrieves a configuration setting.
Syntax
String __fastcall Config(String ConfigurationString);
Remarks
Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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.
CopyFile Method (AzureFile Component)
Copies a file.
Syntax
String __fastcall CopyFile(String FromFilePath, String ToFilePath, String ToShare);
Remarks
This method copies the file at FromFilePath (in the share currently selected by Share) to the path ToFilePath in the share ToShare. If this method finishes successfully, it will either return an asynchronous copy operation Id, or an empty string (if the copy has finished already).
If ToShare is empty, the current value of Share will be used instead. If ToShare is non-empty, the value will automatically be lowercased when preparing the request.
Any parent folders included in ToFilePath must already exist.
If the destination file already exists, it will be overwritten.
As long as the server doesn't return an error, this method will always populate the CopyId and CopyStatus configuration settings (and clear CopyProgress and CopyStatusDesc).
Asynchronous Copy Notes
As mentioned, this method will return a copy operation Id if the copy operation was started asynchronously. In this case, use the GetFileInfo method to poll the destination file's information, which will cause the CopyStatus, CopyStatusDesc, and CopyProgress configuration settings to be refreshed.
A copy operation whose CopyStatus is still pending may also be aborted by passing the copy operation Id returned by this method (or later retrieved from CopyId) to the AbortCopy method.
// Copy a file to another location within the same share.
string copyResult = azurefile.CopyFile("/folder1/important.zip", "/folder2/secrets.zip", "");
// If the returned value *isn't* empty string, then we'll monitor the status of the
// asynchronous copy operation by polling once every 2 seconds using GetFileInfo().
if (!string.IsNullOrEmpty(copyResult)) {
do {
azurefile.GetFileInfo("/folder2/secrets.zip");
Console.WriteLine("Copy progress: " + azurefile.Config("CopyProgress"));
} while (azurefile.Config("CopyStatus") == "pending");
}
CreateFile Method (AzureFile Component)
Initializes a new file.
Syntax
String __fastcall CreateFile(String NewFilePath, __int64 FileLength);
Remarks
This method initializes a new file with a given FileLength (in bytes) at the specified NewFilePath in the share currently selected by Share. The path of the newly-initialized file is returned.
Any parent folders included in NewFilePath must already exist.
If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.
Note: This method is typically only useful for advanced use-cases. To upload a file, just call UploadFile.
Usage Notes
This method does not upload or otherwise allocate any data, it just creates the file entry and "reserves" storage space for it. After a file has been created with this method, the following methods can be used to manipulate its data:
- The PutRange method can be used to upload ranges of data (up to 4MB at once) to the file.
- The ClearRange method can be used to clear an arbitrary range of data from the file, allowing the server to release the associated storage resources.
- The GetRanges method can be used to obtain a list of all data ranges present in the file.
CreateFolder Method (AzureFile Component)
Creates a new folder.
Syntax
String __fastcall CreateFolder(String NewFolderPath);
Remarks
This method creates a new folder at the specified NewFolderPath in the share currently selected by Share. The path of the newly-created folder is returned.
Any parent folders included in NewFolderPath must already exist.
If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.
CreateShare Method (AzureFile Component)
Creates a new share.
Syntax
void __fastcall CreateShare();
Remarks
This method creates a new share using the name specified by the Share property.
If the CreateShareQuota configuration setting is a positive, non-zero integer when this method is called, the share will be created with a space quota of that many GB. A share's space quota may be changed at any time using the SetShareQuota method.
If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.
Share Name Rules
Share names must adhere to the following rules:
- Must be 3 to 63 characters long.
- Must start with a letter or number; and may only contain letters, numbers, and hyphens.
- All letters much be lowercase. (For convenience, the component will automatically lowercase all letters in any value assigned to Share.)
- All hyphens must be immediately preceded and followed by a letter or number (consecutive hyphens are not allowed).
DelFile Method (AzureFile Component)
Deletes a file.
Syntax
void __fastcall DelFile(String FilePath);
Remarks
DeleteFolder Method (AzureFile Component)
Deletes a folder.
Syntax
void __fastcall DeleteFolder(String FolderPath);
Remarks
This method deletes the folder at the specified FolderPath in the share currently selected by Share.
Only empty folders may be deleted; non-empty folders must be emptied first.
DeleteShare Method (AzureFile Component)
Deletes a share.
Syntax
void __fastcall DeleteShare();
Remarks
This method deletes the share currently selected by the Share property.
If the currently selected Share has any snapshots associated with it, and the DeleteShareSnapshots configuration setting is disabled (default) when this method is called, the server will return an error. Shares with snapshots can only be deleted after enabling DeleteShareSnapshots.
Note that, according to the Azure File Storage documentation, a share's name cannot be reused until at least 30 seconds after its deletion.
DownloadFile Method (AzureFile Component)
Downloads a file.
Syntax
void __fastcall DownloadFile(String FilePath);
Remarks
This method downloads the file at the specified FilePath in the share currently selected by Share.
If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.
To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.
Download Notes
In the simplest use-case, downloading a file looks like this:
azurefile.LocalFile = "../MyFile.zip";
azurefile.DownloadFile(azurefile.Resources[0].Path);
Resuming Downloads
The component also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.
string downloadFile = "../MyFile.zip";
azurefile.LocalFile = downloadFile;
azurefile.DownloadFile(azurefile.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially downloaded file
azurefile.StartByte = new FileInfo(downloadFile).Length;
azurefile.DownloadFile(azurefile.Resources[0].Path);
Resuming Encrypted File Downloads
Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.
If LocalFile is set when beginning an encrypted download, the component creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.
To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.
azurefile.LocalFile = "../MyFile.zip";
azurefile.EncryptionPassword = "password";
azurefile.DownloadFile(azurefile.Resources[0].Path);
//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:
//Get the size of the partially download temp file
azurefile.StartByte = new FileInfo(azurefile.Config("DownloadTempFile")).Length;
azurefile.DownloadFile(azurefile.Resources[0].Path);
GetFileInfo Method (AzureFile Component)
Gets a file's information and metadata.
Syntax
void __fastcall GetFileInfo(String FilePath);
Remarks
This method gets information and metadata for the file at the specified FilePath in the share currently selected by Share.
Calling this method will fire the ResourceList event, will re-populate the Resources properties with a single item, and will re-populate the Metadata properties with any metadata currently associated with the file.
GetFolderInfo Method (AzureFile Component)
Gets a folder's information and metadata.
Syntax
void __fastcall GetFolderInfo(String FolderPath);
Remarks
This method gets information and metadata for the folder at the specified FolderPath in the share currently selected by Share.
FolderPath can be empty string to get information about the root folder of the share.
Calling this method will fire the ResourceList event, will re-populate the Resources properties with a single item, and will re-populate the Metadata properties with any metadata currently associated with the folder.
GetLink Method (AzureFile Component)
Creates a link that provides access to a share or file.
Syntax
String __fastcall GetLink(String FilePath, String Permissions, String StartTime, String ExpiryTime);
Remarks
This method creates and returns a shared access signature (SAS), which is a link that provides access to a specific share or file. The following table indicates which inputs must be provided to produce a link of the desired type:
Permissions specifies what permissions the SAS grants, in the form of an abbreviated permissions list. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format this value.
StartTime and ExpiryTime specify the UTC start and end times of the SAS's validity interval. Refer to this section of Azure's "Create a Service SAS" article for more information about how to format these values.
StartTime may be empty, in which case the server will assume that the link is valid immediately. Permissions and ExpiryTime must both be non-empty, unless an si query parameter that references a stored access policy (which has corresponding non-empty values) is present in the QueryParams properties.
If any of the query parameters listed below are present in the QueryParams properties when this method is called, they will be included when creating the SAS. All other application-specified query parameters are ignored.
- Response headers: rscc, rscd, rsce, rscl, rsct
- IP address (single or range): sip
- Allowed HTTP protocol(s): spr
- Stored access policy ("signed identifier"): si
For more information about SAS links, refer to Azure's Create a Service SAS article.
GetRanges Method (AzureFile Component)
Gets the list of allocated data ranges in a file.
Syntax
void __fastcall GetRanges(String FilePath);
Remarks
This method gets the list of allocated data ranges in the file at the specified FilePath in the share currently selected by Share and populates the Ranges properties with the results.
The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file; thus, the size of every range returned by this method will always be a multiple of 512. Chunks that are not currently allocated (either because no data has been written to them, or because they've been freed with ClearRange) will not be returned by this method.
GetShareInfo Method (AzureFile Component)
Gets a share's information and metadata.
Syntax
void __fastcall GetShareInfo();
Remarks
This method gets information and metadata for the share currently selected by the Share property.
Calling this method will fire the ShareList event, will re-populate the Shares properties with a single item, and will re-populate the Metadata properties with any metadata currently associated with the share.
Interrupt Method (AzureFile Component)
This method interrupts the current method.
Syntax
void __fastcall Interrupt();
Remarks
If there is no method in progress, Interrupt simply returns, doing nothing.
ListResources Method (AzureFile Component)
Lists resources in a given folder.
Syntax
void __fastcall ListResources(String FolderPath);
Remarks
This method lists the resources in the folder at the specified FolderPath in the share currently selected by Share.
Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned.
Calling this method will fire the ResourceList event once for each resource, and will also populate the Resources properties.
If there are still more resources available to list when this method returns, the ResourceMarker property will be populated. Continue to call this method until ResourceMarker is empty to accumulate all pages of results in the Resources properties.
Note that the server only returns the following resource properties when listing resources (use GetFileInfo or GetFolderInfo to retrieve all properties for a specific resource):
- ResourceName
- ResourcePath (populated by the component automatically)
- ResourceShare (populated by the component automatically)
- ResourceSize
- ResourceType
// ResourceList event handler.
azurefile.OnResourceList += (s, e) => {
Console.WriteLine(e.Name);
};
azurefile.Share = "myshare";
do {
azurefile.ListResources("/work_files/serious_business/cats");
for (int i = 0; i < azurefile.Resources.Count; i++) {
// Process resources here.
}
} while (!string.IsNullOrEmpty(azurefile.ResourceMarker));
ListShares Method (AzureFile Component)
Lists shares in the file storage account.
Syntax
void __fastcall ListShares();
Remarks
This method lists the shares in the file storage account specified by the Account property.
Before calling this method, the Prefix property may be set in order to restrict the results to only the items whose names begin with a given string. The MaxResults configuration setting may also be used to limit the number of results returned.
Calling this method will fire the ShareList event once for each share, and will also populate the Shares properties.
If there are still more shares available to list when this method returns, the ShareMarker property will be populated. Continue to call this method until ShareMarker is empty to accumulate all pages of results in the Shares properties.
Note that the server does not return the shares' ShareSpaceUsed property when listing shares; use GetShareInfo to retrieve all properties for a specific share.
// ShareList event handler.
azurefile.OnShareList += (s, e) => {
Console.WriteLine(e.Name);
};
do {
azurefile.ListShares();
for (int i = 0; i < azurefile.Shares.Count; i++) {
// Process shares here.
}
} while (!string.IsNullOrEmpty(azurefile.ShareMarker));
PutRange Method (AzureFile Component)
Uploads a range of data to a file.
Syntax
void __fastcall PutRange(String FilePath, __int64 WriteOffset);
Remarks
This method uploads a range of data to the file at the specified FilePath in the share currently selected by Share. The data to upload cannot be larger than 4MB (4194304 bytes), and is written to the file at the given WriteOffset (specified in bytes).
The server tracks ranges of file data in 512-byte chunks, aligned to the absolute beginning of the file. However, neither the WriteOffset nor the length of the data to upload need be a multiple of 512. Any portions of a chunk not written to will be populated with 0s.
Note that, according to the Azure File Storage documentation, this operation requires a write lock on the entire file in order to complete successfully.
RenameFile Method (AzureFile Component)
Renames a file.
Syntax
void __fastcall RenameFile(String OldFilePath, String NewFilePath);
Remarks
This method moves and/or renames an existing file on the server at the specified OldFilePath in the share currently selected by Share. The NewFilePath parameter indicates the new location and name of the file.
Any parent folders included in NewFilePath must already exist.
The Overwrite property can optionally be enabled to overwrite the file if it already exists at the location specified by NewFilePath.
RenameFolder Method (AzureFile Component)
Renames a directory.
Syntax
void __fastcall RenameFolder(String OldDirPath, String NewDirPath);
Remarks
This method moves and/or renames an existing folder on the server at the specified OldDirPath in the share currently selected by Share. The NewDirPath parameter indicates the new location and name of the folder.
Any parent folders included in NewDirPath must already exist.
Reset Method (AzureFile Component)
Resets the component to its initial state.
Syntax
void __fastcall Reset();
Remarks
This method resets the component to its initial state.
ResizeFile Method (AzureFile Component)
Resizes a file.
Syntax
void __fastcall ResizeFile(String FilePath, __int64 NewSize);
Remarks
This method resizes the file at the specified FilePath in the share currently selected by Share. NewSize, which is specified in bytes, cannot be negative.
SetShareQuota Method (AzureFile Component)
Sets a share's space quota.
Syntax
void __fastcall SetShareQuota(int Quota);
Remarks
This method sets the size, in GB, of the space quota imposed on the share currently selected by the Share property. Quota must be greater than 0.
It is legal to lower a share's quota to a value less than its current space usage. However, doing so will prevent new space from being allocated until either the space usage falls below quota or the quota is raised above the space usage.
UpdateMetadata Method (AzureFile Component)
Sets the metadata for a file, folder, or share.
Syntax
void __fastcall UpdateMetadata(String Path, int ResourceType);
Remarks
This method sets the metadata for a file, folder, or share to the items currently held by the Metadata properties. The ResourceType parameter indicates the kind of resource the component should prepare the request for; possible values are:
- 0: Set the metadata for the file at the specified Path in the share currently selected by Share.
- 1: Set the metadata for the folder at the specified Path in the share currently selected by Share.
- 2: Set the metadata for the share currently selected by Share (Path is ignored).
Note that it is not possible to do a partial metadata update. That is, all metadata currently associated with the remote entity will be replaced with the metadata sent in the request.
UploadFile Method (AzureFile Component)
Uploads a new file resource.
Syntax
String __fastcall UploadFile(String NewFilePath);
Remarks
This method uploads a new file resource at the specified NewFilePath in the share currently selected by Share. The path of the newly-created file is returned.
Any parent folders included in NewFilePath must already exist.
If the SendMetadata configuration setting is enabled when this method is called, all items in the Metadata properties will be sent along with the creation request.
If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.
To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.
Upload Notes
The UploadFile method is a convenience method that performs a resumable file upload. When called, the component first uses CreateFile to initialize a new file entry on the server; and then it fragments the file data into smaller pieces and calls PutRange multiple times in succession to upload those fragments. The fragment size is fixed at 4MB (this is a server limitation that cannot be changed).
During the upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The component also updates StartByte as necessary to indicate the current offset in the file.
If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the component is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.
azurefile.LocalFile = "../MyFile.zip";
azurefile.UploadFile("MyFile.zip");
//The transfer is interrupted and UploadFile() above fails. Later, resume the download.
//Using the same instance StartByte is already populated from the previous upload attempt.
azurefile.UploadFile("MyFile.zip");
EndTransfer Event (AzureFile Component)
This event fires when a document finishes transferring.
Syntax
typedef struct { int Direction; } TcsAzureFileEndTransferEventParams; typedef void __fastcall (__closure *TcsAzureFileEndTransferEvent)(System::TObject* Sender, TcsAzureFileEndTransferEventParams *e); __property TcsAzureFileEndTransferEvent OnEndTransfer = { read=FOnEndTransfer, write=FOnEndTransfer };
Remarks
The EndTransfer event is fired when the document text finishes transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Error Event (AzureFile Component)
Fired when information is available about errors during data delivery.
Syntax
typedef struct { int ErrorCode; String Description; } TcsAzureFileErrorEventParams; typedef void __fastcall (__closure *TcsAzureFileErrorEvent)(System::TObject* Sender, TcsAzureFileErrorEventParams *e); __property TcsAzureFileErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
FragmentComplete Event (AzureFile Component)
Fires after each fragment of a resumable upload is completed.
Syntax
typedef struct { int FragmentNumber; int FragmentCount; bool Interrupt; } TcsAzureFileFragmentCompleteEventParams; typedef void __fastcall (__closure *TcsAzureFileFragmentCompleteEvent)(System::TObject* Sender, TcsAzureFileFragmentCompleteEventParams *e); __property TcsAzureFileFragmentCompleteEvent OnFragmentComplete = { read=FOnFragmentComplete, write=FOnFragmentComplete };
Remarks
When UploadFile is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.
FragmentNumber is the number of the current fragment that has completed. This value begins at 1.
FragmentCount is the total number of fragments that will be uploaded.
Interrupt can be set to true to interrupt the upload. The upload may be resumed later.
Header Event (AzureFile Component)
This event is fired every time a header line comes in.
Syntax
typedef struct { String Field; String Value; } TcsAzureFileHeaderEventParams; typedef void __fastcall (__closure *TcsAzureFileHeaderEvent)(System::TObject* Sender, TcsAzureFileHeaderEventParams *e); __property TcsAzureFileHeaderEvent OnHeader = { read=FOnHeader, write=FOnHeader };
Remarks
The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.
If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).
Log Event (AzureFile Component)
This event fires once for each log message.
Syntax
typedef struct { int LogLevel; String Message; String LogType; } TcsAzureFileLogEventParams; typedef void __fastcall (__closure *TcsAzureFileLogEvent)(System::TObject* Sender, TcsAzureFileLogEventParams *e); __property TcsAzureFileLogEvent OnLog = { read=FOnLog, write=FOnLog };
Remarks
This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.
LogLevel indicates the level of message. Possible values are as follows:
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
Message is the log entry.
LogType identifies the type of log entry. Possible values are as follows:
- "Info"
- "RequestHeaders"
- "ResponseHeaders"
- "RequestBody"
- "ResponseBody"
- "ProxyRequest"
- "ProxyResponse"
- "FirewallRequest"
- "FirewallResponse"
Progress Event (AzureFile Component)
Fires during an upload or download to indicate transfer progress.
Syntax
typedef struct { int Direction; __int64 BytesTransferred; __int64 TotalBytes; int PercentDone; } TcsAzureFileProgressEventParams; typedef void __fastcall (__closure *TcsAzureFileProgressEvent)(System::TObject* Sender, TcsAzureFileProgressEventParams *e); __property TcsAzureFileProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };
Remarks
This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.
Direction indicates whether the transfer is an upload (0) or a download (1).
BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).
TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.
PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.
Note: By default, the component 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 component will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.
ResourceList Event (AzureFile Component)
Fires once for each resource returned when listing resources.
Syntax
typedef struct { String Name; String Path; String Share; int ResourceType; String ModifiedTime; __int64 Size; String ETag; } TcsAzureFileResourceListEventParams; typedef void __fastcall (__closure *TcsAzureFileResourceListEvent)(System::TObject* Sender, TcsAzureFileResourceListEventParams *e); __property TcsAzureFileResourceListEvent OnResourceList = { read=FOnResourceList, write=FOnResourceList };
Remarks
This event fires once for each resource returned when ListResources, GetFileInfo, or GetFolderInfo is called.
Name is the name of the resource.
Path is the full path of the resource (not including the share).
Share is the name of the share the resource resides in.
ResourceType reflects the resource's type. Possible values are:
0 (afrtFile) | A file. |
1 (afrtFolder) | A folder. |
ModifiedTime is the last modified time of the resource, formatted according to RFC 1123. (Note: this parameter is not populated by calls to ListResources.)
Size is the size of the file. Always 0 for folders.
ETag is the ETag of the resource. (Note: this parameter is not populated by calls to ListResources.)
ShareList Event (AzureFile Component)
Fires once for each share returned when listing shares.
Syntax
typedef struct { String Name; String ModifiedTime; String ETag; int Quota; } TcsAzureFileShareListEventParams; typedef void __fastcall (__closure *TcsAzureFileShareListEvent)(System::TObject* Sender, TcsAzureFileShareListEventParams *e); __property TcsAzureFileShareListEvent OnShareList = { read=FOnShareList, write=FOnShareList };
Remarks
This event fires once for each share returned when ListShares or GetShareInfo is called.
Name is the name of the share.
ModifiedTime is the last modified time of the share, formatted according to RFC 1123.
ETag is the ETag of the share.
Quota is the share's space quota, in GB.
SSLServerAuthentication Event (AzureFile Component)
Fired after the server presents its certificate to the client.
Syntax
typedef struct { String CertEncoded; DynamicArray<Byte> CertEncodedB; String CertSubject; String CertIssuer; String Status; bool Accept; } TcsAzureFileSSLServerAuthenticationEventParams; typedef void __fastcall (__closure *TcsAzureFileSSLServerAuthenticationEvent)(System::TObject* Sender, TcsAzureFileSSLServerAuthenticationEventParams *e); __property TcsAzureFileSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };
Remarks
During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.
When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.
SSLStatus Event (AzureFile Component)
Fired when secure connection progress messages are available.
Syntax
typedef struct { String Message; } TcsAzureFileSSLStatusEventParams; typedef void __fastcall (__closure *TcsAzureFileSSLStatusEvent)(System::TObject* Sender, TcsAzureFileSSLStatusEventParams *e); __property TcsAzureFileSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };
Remarks
The event is fired for informational and logging purposes only. This event tracks the progress of the connection.
StartTransfer Event (AzureFile Component)
This event fires when a document starts transferring (after the headers).
Syntax
typedef struct { int Direction; } TcsAzureFileStartTransferEventParams; typedef void __fastcall (__closure *TcsAzureFileStartTransferEvent)(System::TObject* Sender, TcsAzureFileStartTransferEventParams *e); __property TcsAzureFileStartTransferEvent OnStartTransfer = { read=FOnStartTransfer, write=FOnStartTransfer };
Remarks
The StartTransfer event is fired when the document text starts transferring from the server to the local host.
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
Transfer Event (AzureFile Component)
This event is fired while a document transfers (delivers document).
Syntax
typedef struct { int Direction; __int64 BytesTransferred; int PercentDone; String Text; DynamicArray<Byte> TextB; } TcsAzureFileTransferEventParams; typedef void __fastcall (__closure *TcsAzureFileTransferEvent)(System::TObject* Sender, TcsAzureFileTransferEventParams *e); __property TcsAzureFileTransferEvent OnTransfer = { read=FOnTransfer, write=FOnTransfer };
Remarks
The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.
The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).
The Direction parameter shows whether the client (0) or the server (1) is sending the data.
The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.
Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.
Config Settings (AzureFile Component)
The component 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 component, access to these internal properties is provided through the Config method.AzureFile Config Settings
By default, this setting is enabled, allowing all pages of results to be accumulated in the appropriate collection properties.
Note that this setting cannot be changed.
This setting is populated after calling CopyFile, or after calling GetFileInfo for the destination file in a copy operation.
Calling CopyFile will clear this setting; call GetFileInfo for the destination file in a copy operation to populate it.
- pending
- success
- aborted
- failed
This setting is populated after calling CopyFile, or after calling GetFileInfo for the destination file in a copy operation.
- If the operation is pending, the description may reflect any non-fatal errors which have occurred thus far.
- If the operation is failed, the description will detail the fatal error which caused the failure.
- Otherwise, the description will always be empty.
Calling CopyFile will clear this setting; call GetFileInfo for the destination file in a copy operation to populate it.
If set to 0 (default), no explicit space quota is imposed on the share when it is created. Note that a share's space quota may be changed at any time using the SetShareQuota method.
If this setting is disabled (default), calling DeleteShare will fail if the specified share has any snapshots associated with it.
When downloading encrypted data with LocalFile set, the component will automatically create a temporary file at TempPath to hold the encrypted file contents. When the download is complete, the data is decrypted to LocalFile.
If the download is interrupted, the specified file will hold the partially downloaded encrypted file contents. Before resuming the download, this setting must be set to a valid file containing the partially encrypted file contents. See DownloadFile for details.
This setting accepts a hex encoded value.
This setting accepts a hex encoded value.
- 0 (default) - PBKDF1
- 1 - PBKDF2
In most cases, the default endpoint suffix is the correct choice. This setting should only be changed if the component needs to use an endpoint suffix associated with a specific National Cloud Deployment, in which case it should be set to one of the values shown in this table:
National Cloud | Endpoint Suffix |
Azure global service | .core.windows.net (default) |
Azure Government (US) | .core.usgovcloudapi.net |
Azure Germany | .core.cloudapi.de |
Azure China | .core.chinacloudapi.cn |
Please note that each National Cloud Deployment also has its own corresponding application registration portal and OAuth endpoints, both of which are completely separate from those used for/by the global Azure Storage services. Applications that wish to work with a specific National Cloud Deployment must use that National Cloud Deployment's app registration portal and OAuth endpoints to register and authenticate in order for the component to successfully communicate using the National Cloud Deployment-specific endpoint. Refer to Microsoft's National Cloud Authentication article for more information.
If this setting is -1 (default), the server's default (5000) is used. Acceptable values are 1 to 5000 (inclusive).
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 component 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.
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 component will behave as if this setting were 0 for the duration of the transfer.
By default, this setting is disabled, and resources are not automatically created with metadata.
If this setting is disabled (default), or if this setting is enabled but there are no Metadata items, then the server will copy the original metadata from the source file to the destination file.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
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 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. |
For example, assume the following XML and JSON responses.
XML:
<firstlevel> <one>value</one> <two> <item>first</item> <item>second</item> </two> <three>value three</three> </firstlevel>
JSON:
{ "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } }
The following are examples of valid XPaths for these responses:
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 list is not exhaustive, but it provides a general idea of the possibilities.
The current element is specified through the XPath configuration setting. This configuration setting is read-only.
The current element is specified in the XPath configuration setting. This configuration setting is read-only.
HTTP Config Settings
When True, the component adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".
The default value is True.
If set to True (default), the component will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the component raises an exception if the server does not support HTTP/2.
The default value is True.
This property is provided so that the HTTP component can be extended with other security schemes in addition to the authorization schemes already implemented by the component.
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]".
The default value is False.
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 component raises an exception.
Note: Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.
Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.
A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).
The default value is 0 (Never). In this case, redirects are never followed, and the component raises an exception instead.
Following are the valid options:
- 0 - Never
- 1 - Always
- 2 - Same Scheme
- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"
When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.
HTTP/2 Notes
When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.
If the server does not support HTTP/2, the component will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.
HTTP/3 Notes
HTTP/3 is supported only in .NET and Java.
When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.
The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:
Sat, 29 Oct 2017 19:43:31 GMT.
The default value for KeepAlive is false.
0 (None) | No events are logged. |
1 (Info - default) | Informational events are logged. |
2 (Verbose) | Detailed data are logged. |
3 (Debug) | Debug data are logged. |
The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.
The value 2 (Verbose) logs additional information about the request and response.
The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).
The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .
Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.
This configuration setting is useful for extending the functionality of the component beyond what is provided.
.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"));
Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.
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.
When True (default), the component will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.
Override the default with the name and version of your software.
TCPClient Config Settings
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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This configuration setting is provided for use by components that do not directly expose Firewall properties.
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 components that do not directly expose Firewall properties.
Note: This setting is provided for use by components that do not directly expose Firewall properties.
Note: This value is not applicable in macOS.
In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.
In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.
The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the component returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).
Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.
In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the component initiate connections (or accept in the case of server components) only through that interface.
If the component 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 multihomed hosts (machines with more than one IP interface).
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 configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.
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.
www.google.com;www.nsoftware.com
Note: This value is not applicable in Java.
By default, this configuration setting is set to False.
0 | IPv4 only |
1 | IPv6 only |
2 | IPv6 with IPv4 fallback |
SSL Config Settings
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 configuration setting has no effect if SSLProvider is set to Platform.
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). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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 the following sequences:
-----BEGIN CERTIFICATE-----
... (CA certificate in base64 encoding) ...
-----END CERTIFICATE-----
Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.
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".
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.
If set to True, the component 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 component is the same.
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermedaite Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When set to 0 (default), the CRL check will not be performed by the component. When set to 1, it will attempt to perform the CRL check, but it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
When set to 0 (default), the component will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.
This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems.
Note: This configuration 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 configuration 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 configuration setting.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
By default, the enabled cipher suites will include all available ciphers ("*").
The special value "*" means that the component 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 include the following:
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 the following:
- 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
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_ECDH_RSA_WITH_AES_128_CBC_SHA");
Possible values when SSLProvider is set to Internal include the following:
- 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_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.
Not all supported protocols are enabled by default. The default value is 4032 for client components, and 3072 for server components. To specify a combination of enabled protocol versions set this config to the binary OR of one or more of the following values:
TLS1.3 | 12288 (Hex 3000) |
TLS1.2 | 3072 (Hex C00) (Default - Client and Server) |
TLS1.1 | 768 (Hex 300) (Default - Client) |
TLS1 | 192 (Hex C0) (Default - Client) |
SSL3 | 48 (Hex 30) |
SSL2 | 12 (Hex 0C) |
Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.
SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:
By default when TLS 1.3 is enabled, the component will use the internal TLS implementation when the SSLProvider is set to Automatic for all editions.
In editions that 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 supported only 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 available only 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, these restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.
SSLEnabledProtocols: SSL2 and SSL3 Notes:
SSL 2.0 and 3.0 are not supported by the component when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.
This configuration setting is applicable only when SSLProvider is set to Internal.
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.
When set, the component 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 traffic for debugging purposes. When writing to this file, the component will only append, it will not overwrite previous values.
Note: This configuration setting is applicable only when SSLProvider is set to Internal.
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipher[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedCipherSuite[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchange[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
Note: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:
server.Config("SSLNegotiatedVersion[connId]");
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 non-matching server name). |
This functionality is currently not available when the provider is OpenSSL.
The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:
-----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE-----
When specified the component will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the component raises an exception.
The format of this value is a comma-separated list of hash-signature combinations. For instance:
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
The default value for this configuration 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.
To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.
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)
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 configuration setting.
Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group.
In most cases, this configuration setting does not need to be modified. This should be modified only 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"
- "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 ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192
The values are ordered from most preferred to least preferred. The following values are supported:
- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
Socket Config Settings
Note: This option is not valid for User Datagram Protocol (UDP) ports.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the component is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.
Base Config Settings
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 |
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 |
- 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.
This setting only works on these components: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to true. This is a static setting that applies to all instances of all components of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.
For more details, please see the FIPS 140-2 Compliance article.
Note: This setting is applicable only on Windows.
Note: Enabling FIPS compliance requires a special license; please contact sales@nsoftware.com for details.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (AzureFile Component)
Common Errors
600 | A server error occurred, and/or the component 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 component 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 component may also return one of the following error codes, which are inherited from other components.
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 component may also return one of the following error codes, which are inherited from other components.
TCPClient Errors
100 | You cannot change the RemotePort at this time. A connection is in progress. |
101 | You cannot change the RemoteHost (Server) at this time. A connection is in progress. |
102 | The RemoteHost address is invalid (0.0.0.0). |
104 | Already connected. If you want to reconnect, close the current connection first. |
106 | You cannot change the LocalPort at this time. A connection is in progress. |
107 | You cannot change the LocalHost at this time. A connection is in progress. |
112 | You cannot change MaxLineLength at this time. A connection is in progress. |
116 | RemotePort cannot be zero. Please specify a valid service port number. |
117 | You cannot change the UseConnection option while the component 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 nonsocket. |
10039 | [10039] Destination address required. |
10040 | [10040] Message is too long. |
10041 | [10041] Protocol wrong type for socket. |
10042 | [10042] Bad protocol option. |
10043 | [10043] Protocol is not supported. |
10044 | [10044] Socket type is not supported. |
10045 | [10045] Operation is not supported on socket. |
10046 | [10046] Protocol family is not supported. |
10047 | [10047] Address family is not supported by protocol family. |
10048 | [10048] Address already in use. |
10049 | [10049] Cannot 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] Cannot send after socket shutdown. |
10059 | [10059] Too many references, cannot splice. |
10060 | [10060] Connection timed out. |
10061 | [10061] Connection refused. |
10062 | [10062] Too many levels of symbolic links. |
10063 | [10063] File name is too long. |
10064 | [10064] Host is down. |
10065 | [10065] No route to host. |
10066 | [10066] Directory is 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 is not loaded yet. |
11001 | [11001] Host not found. |
11002 | [11002] Nonauthoritative 'Host not found' (try again or check DNS setup). |
11003 | [11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP. |
11004 | [11004] Valid name, no data record (check DNS setup). |