FTPClient Component

Properties   Methods   Events   Config Settings   Errors  

The FTPClient component provides client-side functionality for FTP and FTPS protocols.

Syntax

TsbxFTPClient

Remarks

FTPClient provides client-side support for the FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations with a remote server over Transport Layer Security (TLS).

Note: TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

FTPClient is typically used in the following scenario:

• Setting up the connection parameters
• Connecting to the server and signing in
• Performing file transfer operations
• Closing the connection

Setting up the parameters

When working with FTP or FTP-over-TLS service you will often need to tune up several classes of settings:

• Login credentials: these can be tuned up via the Username and Password properties.
• TLS settings: these includes the TLS mode: explicit, implicit, or no TLS. You must get this setting right; otherwise you may not be able to connect. Use TLSSettings property to adjust this setting.
• If your server requires you to authenticate with a certificate, you can provide one via the TLSClientChain property.
• FTPClient validates the server certificate against the local security settings. If your server uses a custom or non-public PKI, you may need to provide the required trust anchors and CA certificates via the TrustedCertificates and KnownCertificates collections.
• FTP protocol includes its own set of settings, such as PassiveMode, EncryptDataChannel, or AdjustPasvAddress. These may be configured on this stage, or later into the connection.
• In some network environments, you may also need to make adjustments to SocketSettings and Proxy.

Connecting to the server and signing in

Call Connect to open the connection to the server. The component will use the provided credentials to sign you in automatically.

Performing file transfer operations

FTPClient offers the full set of FTP operations. These include file uploads (UploadFile or UploadBytes), file downloads (DownloadFile, DownloadBytes), and directory operations (ListDir, MakeDir).

Note that unlike SFTP, FTP only supports one transfer operation at a time. An ongoing operation should be completed or aborted before a new one can be started.

Closing the connection

Use Disconnect to close the FTP connection.

Useful info

During its work FTPClient communicates back via events. Progress event fires periodically during the transfer operation to let you know of the operation progress. ControlSend and ControlReceive report the protocol communication log. FileOperation and FileOperationResult report the start and completion of an individual transfer operation within a multi-file transfer call (such as UploadFiles).

Property List

---

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

Method List

---

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

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.

Config Settings

---

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

AccountInfo Property (FTPClient Component)

Parameters for the ACCT command.

Syntax

__property String AccountInfo = { read=FAccountInfo, write=FSetAccountInfo };

Default Value

""

Remarks

Specifies the parameter for ACCT command. If AccountInfo is set, the client automatically sends ACCT command to the server during authentication.

Data Type

String

AdjustPasvAddress Property (FTPClient Component)

Enables or disables automatic adjustment of passive-mode addresses.

Syntax

__property bool AdjustPasvAddress = { read=FAdjustPasvAddress, write=FSetAdjustPasvAddress };

Default Value

true

Remarks

Occasional NAT'ed servers misbehave by returning local IP addresses in their PASV mode offers, which are not reachable from the outer network. Set this property to true to make the component enforce data connections to the same address as the control connection uses.

Note that sometimes (typically, with multi-faced FTP services aka FTP Clouds) you may need to disable this property to make the transfers work right.

Data Type

Boolean

BlockedCertCount Property (FTPClient Component)

The number of records in the BlockedCert arrays.

Syntax

__property int BlockedCertCount = { read=FBlockedCertCount, write=FSetBlockedCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• BlockedCertBytes
• BlockedCertHandle

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

This property is not available at design time.

Data Type

Integer

BlockedCertBytes Property (FTPClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray BlockedCertBytes[int BlockedCertIndex] = { read=FBlockedCertBytes };

Remarks

Returns the raw certificate data in DER format.

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

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

Data Type

Byte Array

BlockedCertHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 BlockedCertHandle[int BlockedCertIndex] = { read=FBlockedCertHandle, write=FSetBlockedCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The BlockedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the BlockedCertCount property.

This property is not available at design time.

Data Type

Long64

ConflictResolutionMode Property (FTPClient Component)

Defines the approach that should be used to resolve various conflicts during batch processing.

Syntax

__property TsbxFTPClientConflictResolutionModes ConflictResolutionMode = { read=FConflictResolutionMode, write=FSetConflictResolutionMode };

enum TsbxFTPClientConflictResolutionModes {
  cftmOverwrite=0,
  cftmSkip=1,
  cftmAppendToEnd=2,
  cftmResume=3,
  cftmOverwriteIfDiffSize=4,
  cftmSaveWithNewName=5,
  cftmRenameExistingTarget=6
};

Default Value

cftmOverwrite

Remarks

Use this property to specify the approach to use when landing in conflicting transfer situations.

Data Type

Integer

Connected Property (FTPClient Component)

Indicates whether the component is connected to the server.

Syntax

__property bool Connected = { read=FConnected };

Default Value

false

Remarks

Use this property to check if the connection to server is active.

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

Data Type

Boolean

ControlChannelLog Property (FTPClient Component)

Contains the control channel log of the FTP session.

Syntax

__property String ControlChannelLog = { read=FControlChannelLog };

Default Value

""

Remarks

Use this property to access the FTP protocol log (client commands followed by server responses).

This property is read-only.

Data Type

String

CtlConnInfoAEADCipher Property (FTPClient Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

__property bool CtlConnInfoAEADCipher = { read=FCtlConnInfoAEADCipher };

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

Boolean

CtlConnInfoChainValidationDetails Property (FTPClient Component)

The details of a certificate chain validation outcome.

Syntax

__property int CtlConnInfoChainValidationDetails = { read=FCtlConnInfoChainValidationDetails };

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

CtlConnInfoChainValidationResult Property (FTPClient Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxFTPClientCtlConnInfoChainValidationResults CtlConnInfoChainValidationResult = { read=FCtlConnInfoChainValidationResult };

enum TsbxFTPClientCtlConnInfoChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

CtlConnInfoCiphersuite Property (FTPClient Component)

The cipher suite employed by this connection.

Syntax

__property String CtlConnInfoCiphersuite = { read=FCtlConnInfoCiphersuite };

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only.

Data Type

String

CtlConnInfoClientAuthenticated Property (FTPClient Component)

Specifies whether client authentication was performed during this connection.

Syntax

__property bool CtlConnInfoClientAuthenticated = { read=FCtlConnInfoClientAuthenticated };

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

Boolean

CtlConnInfoClientAuthRequested Property (FTPClient Component)

Specifies whether client authentication was requested during this connection.

Syntax

__property bool CtlConnInfoClientAuthRequested = { read=FCtlConnInfoClientAuthRequested };

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

Boolean

CtlConnInfoConnectionEstablished Property (FTPClient Component)

Indicates whether the connection has been established fully.

Syntax

__property bool CtlConnInfoConnectionEstablished = { read=FCtlConnInfoConnectionEstablished };

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

Boolean

CtlConnInfoConnectionID Property (FTPClient Component)

The unique identifier assigned to this connection.

Syntax

__property DynamicArray CtlConnInfoConnectionID = { read=FCtlConnInfoConnectionID };

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

CtlConnInfoDigestAlgorithm Property (FTPClient Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

__property String CtlConnInfoDigestAlgorithm = { read=FCtlConnInfoDigestAlgorithm };

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

CtlConnInfoEncryptionAlgorithm Property (FTPClient Component)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

__property String CtlConnInfoEncryptionAlgorithm = { read=FCtlConnInfoEncryptionAlgorithm };

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

CtlConnInfoExportable Property (FTPClient Component)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

__property bool CtlConnInfoExportable = { read=FCtlConnInfoExportable };

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

Data Type

Boolean

CtlConnInfoID Property (FTPClient Component)

The client connection's unique identifier.

Syntax

__property __int64 CtlConnInfoID = { read=FCtlConnInfoID };

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

This property is read-only.

Data Type

Long64

CtlConnInfoKeyExchangeAlgorithm Property (FTPClient Component)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

__property String CtlConnInfoKeyExchangeAlgorithm = { read=FCtlConnInfoKeyExchangeAlgorithm };

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

CtlConnInfoKeyExchangeKeyBits Property (FTPClient Component)

The length of the key exchange key of a TLS-enabled connection.

Syntax

__property int CtlConnInfoKeyExchangeKeyBits = { read=FCtlConnInfoKeyExchangeKeyBits };

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

Integer

CtlConnInfoNamedECCurve Property (FTPClient Component)

The elliptic curve used in this connection.

Syntax

__property String CtlConnInfoNamedECCurve = { read=FCtlConnInfoNamedECCurve };

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only.

Data Type

String

CtlConnInfoPFSCipher Property (FTPClient Component)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

__property bool CtlConnInfoPFSCipher = { read=FCtlConnInfoPFSCipher };

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

Data Type

Boolean

CtlConnInfoPreSharedIdentity Property (FTPClient Component)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String CtlConnInfoPreSharedIdentity = { read=FCtlConnInfoPreSharedIdentity };

Default Value

""

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

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

Data Type

String

CtlConnInfoPreSharedIdentityHint Property (FTPClient Component)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

__property String CtlConnInfoPreSharedIdentityHint = { read=FCtlConnInfoPreSharedIdentityHint };

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only.

Data Type

String

CtlConnInfoPublicKeyBits Property (FTPClient Component)

The length of the public key.

Syntax

__property int CtlConnInfoPublicKeyBits = { read=FCtlConnInfoPublicKeyBits };

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

Integer

CtlConnInfoRemoteAddress Property (FTPClient Component)

The client's IP address.

Syntax

__property String CtlConnInfoRemoteAddress = { read=FCtlConnInfoRemoteAddress };

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

CtlConnInfoRemotePort Property (FTPClient Component)

The remote port of the client connection.

Syntax

__property int CtlConnInfoRemotePort = { read=FCtlConnInfoRemotePort };

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

Integer

CtlConnInfoResumedSession Property (FTPClient Component)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

__property bool CtlConnInfoResumedSession = { read=FCtlConnInfoResumedSession };

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

Data Type

Boolean

CtlConnInfoSecureConnection Property (FTPClient Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

__property bool CtlConnInfoSecureConnection = { read=FCtlConnInfoSecureConnection };

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

Boolean

CtlConnInfoServerAuthenticated Property (FTPClient Component)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

__property bool CtlConnInfoServerAuthenticated = { read=FCtlConnInfoServerAuthenticated };

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

Data Type

Boolean

CtlConnInfoSignatureAlgorithm Property (FTPClient Component)

The signature algorithm used in a TLS handshake.

Syntax

__property String CtlConnInfoSignatureAlgorithm = { read=FCtlConnInfoSignatureAlgorithm };

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

CtlConnInfoSymmetricBlockSize Property (FTPClient Component)

The block size of the symmetric algorithm used.

Syntax

__property int CtlConnInfoSymmetricBlockSize = { read=FCtlConnInfoSymmetricBlockSize };

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

CtlConnInfoSymmetricKeyBits Property (FTPClient Component)

The key length of the symmetric algorithm used.

Syntax

__property int CtlConnInfoSymmetricKeyBits = { read=FCtlConnInfoSymmetricKeyBits };

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

CtlConnInfoTotalBytesReceived Property (FTPClient Component)

The total number of bytes received over this connection.

Syntax

__property __int64 CtlConnInfoTotalBytesReceived = { read=FCtlConnInfoTotalBytesReceived };

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

CtlConnInfoTotalBytesSent Property (FTPClient Component)

The total number of bytes sent over this connection.

Syntax

__property __int64 CtlConnInfoTotalBytesSent = { read=FCtlConnInfoTotalBytesSent };

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

CtlConnInfoValidationLog Property (FTPClient Component)

Contains the server certificate's chain validation log.

Syntax

__property String CtlConnInfoValidationLog = { read=FCtlConnInfoValidationLog };

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only.

Data Type

String

CtlConnInfoVersion Property (FTPClient Component)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

__property String CtlConnInfoVersion = { read=FCtlConnInfoVersion };

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

Data Type

String

CurrListEntryAccessTime Property (FTPClient Component)

Contains the last access time for this file, in UTC.

Syntax

__property String CurrListEntryAccessTime = { read=FCurrListEntryAccessTime };

Default Value

""

Remarks

Contains the last access time for this file, in UTC.

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

Data Type

String

CurrListEntryCreationTime Property (FTPClient Component)

Contains this file's creation time, in UTC.

Syntax

__property String CurrListEntryCreationTime = { read=FCurrListEntryCreationTime };

Default Value

""

Remarks

Contains this file's creation time, in UTC.

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

Data Type

String

CurrListEntryEntryFormat Property (FTPClient Component)

The file listing format: cfefUnknown 0 cfefUnix 1 cfefWindows 2 cfefMLSD 3 .

Syntax

__property TsbxFTPClientCurrListEntryEntryFormats CurrListEntryEntryFormat = { read=FCurrListEntryEntryFormat };

enum TsbxFTPClientCurrListEntryEntryFormats {
  cfefUnknown=0,
  cfefUnix=1,
  cfefWindows=2,
  cfefMLSD=3
};

Default Value

cfefUnknown

Remarks

The file listing format:

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

Data Type

Integer

CurrListEntryFileType Property (FTPClient Component)

The type of the entry: fetUnknown 0 fetDirectory 1 fetFile 2 fetSymlink 3 fetSpecial 4 fetCurrentDirectory 5 fetParentDirectory 6 fetSocket 7 fetCharDevice 8 fetBlockDevice 9 fetFIFO 10 .

Syntax

__property TsbxFTPClientCurrListEntryFileTypes CurrListEntryFileType = { read=FCurrListEntryFileType };

enum TsbxFTPClientCurrListEntryFileTypes {
  fetUnknown=0,
  fetDirectory=1,
  fetFile=2,
  fetSymlink=3,
  fetSpecial=4,
  fetCurrentDirectory=5,
  fetParentDirectory=6,
  fetSocket=7,
  fetCharDevice=8,
  fetBlockDevice=9,
  fetFIFO=10
};

Default Value

fetUnknown

Remarks

The type of the entry:

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

Data Type

Integer

CurrListEntryHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 CurrListEntryHandle = { read=FCurrListEntryHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

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

Data Type

Long64

CurrListEntryModificationTime Property (FTPClient Component)

File last modification date/time.

Syntax

__property String CurrListEntryModificationTime = { read=FCurrListEntryModificationTime };

Default Value

""

Remarks

File last modification date/time.

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

Data Type

String

CurrListEntryName Property (FTPClient Component)

The file or directory name.

Syntax

__property String CurrListEntryName = { read=FCurrListEntryName };

Default Value

""

Remarks

The file or directory name.

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

Data Type

String

CurrListEntryPath Property (FTPClient Component)

The full path to the file or directory.

Syntax

__property String CurrListEntryPath = { read=FCurrListEntryPath };

Default Value

""

Remarks

The full path to the file or directory.

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

Data Type

String

CurrListEntryPrincipal Property (FTPClient Component)

Specifies the owner of the file/directory.

Syntax

__property String CurrListEntryPrincipal = { read=FCurrListEntryPrincipal };

Default Value

""

Remarks

Specifies the owner of the file/directory.

Note: in earlier versions this property was called Owner. It was renamed to Principal to avoid clashes with certain SDK namings.

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

Data Type

String

CurrListEntrySize Property (FTPClient Component)

File size in bytes.

Syntax

__property __int64 CurrListEntrySize = { read=FCurrListEntrySize };

Default Value

0

Remarks

File size in bytes.

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

Data Type

Long64

CurrListEntryUnixPerms Property (FTPClient Component)

The file Unix permissions bit mask (e.

Syntax

__property int CurrListEntryUnixPerms = { read=FCurrListEntryUnixPerms };

Default Value

511

Remarks

The file Unix permissions bit mask (e.g. rwxrwxrwx=511 (0777); rwxr--r--=484 (0744)).

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

Data Type

Integer

CurrListEntryUnparsedName Property (FTPClient Component)

The unparsed entry as returned by the server.

Syntax

__property String CurrListEntryUnparsedName = { read=FCurrListEntryUnparsedName };

Default Value

""

Remarks

The unparsed entry as returned by the server. Sometimes this is also known as "long name".

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

Data Type

String

DataConnInfoAEADCipher Property (FTPClient Component)

Indicates whether the encryption algorithm used is an AEAD cipher.

Syntax

__property bool DataConnInfoAEADCipher = { read=FDataConnInfoAEADCipher };

Default Value

false

Remarks

Indicates whether the encryption algorithm used is an AEAD cipher.

This property is read-only.

Data Type

Boolean

DataConnInfoChainValidationDetails Property (FTPClient Component)

The details of a certificate chain validation outcome.

Syntax

__property int DataConnInfoChainValidationDetails = { read=FDataConnInfoChainValidationDetails };

Default Value

0

Remarks

The details of a certificate chain validation outcome. They may often suggest the reasons that contributed to the overall validation result.

Returns a bit mask of the following options:

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

Data Type

Integer

DataConnInfoChainValidationResult Property (FTPClient Component)

The outcome of a certificate chain validation routine.

Syntax

__property TsbxFTPClientDataConnInfoChainValidationResults DataConnInfoChainValidationResult = { read=FDataConnInfoChainValidationResult };

enum TsbxFTPClientDataConnInfoChainValidationResults {
  cvtValid=0,
  cvtValidButUntrusted=1,
  cvtInvalid=2,
  cvtCantBeEstablished=3
};

Default Value

cvtValid

Remarks

The outcome of a certificate chain validation routine.

Available options:

Use the ValidationLog property to access the detailed validation log.

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

Data Type

Integer

DataConnInfoCiphersuite Property (FTPClient Component)

The cipher suite employed by this connection.

Syntax

__property String DataConnInfoCiphersuite = { read=FDataConnInfoCiphersuite };

Default Value

""

Remarks

The cipher suite employed by this connection.

For TLS connections, this property returns the ciphersuite that was/is employed by the connection.

This property is read-only.

Data Type

String

DataConnInfoClientAuthenticated Property (FTPClient Component)

Specifies whether client authentication was performed during this connection.

Syntax

__property bool DataConnInfoClientAuthenticated = { read=FDataConnInfoClientAuthenticated };

Default Value

false

Remarks

Specifies whether client authentication was performed during this connection.

This property is read-only.

Data Type

Boolean

DataConnInfoClientAuthRequested Property (FTPClient Component)

Specifies whether client authentication was requested during this connection.

Syntax

__property bool DataConnInfoClientAuthRequested = { read=FDataConnInfoClientAuthRequested };

Default Value

false

Remarks

Specifies whether client authentication was requested during this connection.

This property is read-only.

Data Type

Boolean

DataConnInfoConnectionEstablished Property (FTPClient Component)

Indicates whether the connection has been established fully.

Syntax

__property bool DataConnInfoConnectionEstablished = { read=FDataConnInfoConnectionEstablished };

Default Value

false

Remarks

Indicates whether the connection has been established fully.

This property is read-only.

Data Type

Boolean

DataConnInfoConnectionID Property (FTPClient Component)

The unique identifier assigned to this connection.

Syntax

__property DynamicArray DataConnInfoConnectionID = { read=FDataConnInfoConnectionID };

Remarks

The unique identifier assigned to this connection.

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

Data Type

Byte Array

DataConnInfoDigestAlgorithm Property (FTPClient Component)

The digest algorithm used in a TLS-enabled connection.

Syntax

__property String DataConnInfoDigestAlgorithm = { read=FDataConnInfoDigestAlgorithm };

Default Value

""

Remarks

The digest algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

DataConnInfoEncryptionAlgorithm Property (FTPClient Component)

The symmetric encryption algorithm used in a TLS-enabled connection.

Syntax

__property String DataConnInfoEncryptionAlgorithm = { read=FDataConnInfoEncryptionAlgorithm };

Default Value

""

Remarks

The symmetric encryption algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

DataConnInfoExportable Property (FTPClient Component)

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

Syntax

__property bool DataConnInfoExportable = { read=FDataConnInfoExportable };

Default Value

false

Remarks

Indicates whether a TLS connection uses a reduced-strength exportable cipher.

This property is read-only.

Data Type

Boolean

DataConnInfoID Property (FTPClient Component)

The client connection's unique identifier.

Syntax

__property __int64 DataConnInfoID = { read=FDataConnInfoID };

Default Value

-1

Remarks

The client connection's unique identifier. This value is used throughout to refer to a particular client connection.

This property is read-only.

Data Type

Long64

DataConnInfoKeyExchangeAlgorithm Property (FTPClient Component)

The key exchange algorithm used in a TLS-enabled connection.

Syntax

__property String DataConnInfoKeyExchangeAlgorithm = { read=FDataConnInfoKeyExchangeAlgorithm };

Default Value

""

Remarks

The key exchange algorithm used in a TLS-enabled connection.

This property is read-only.

Data Type

String

DataConnInfoKeyExchangeKeyBits Property (FTPClient Component)

The length of the key exchange key of a TLS-enabled connection.

Syntax

__property int DataConnInfoKeyExchangeKeyBits = { read=FDataConnInfoKeyExchangeKeyBits };

Default Value

0

Remarks

The length of the key exchange key of a TLS-enabled connection.

This property is read-only.

Data Type

Integer

DataConnInfoNamedECCurve Property (FTPClient Component)

The elliptic curve used in this connection.

Syntax

__property String DataConnInfoNamedECCurve = { read=FDataConnInfoNamedECCurve };

Default Value

""

Remarks

The elliptic curve used in this connection.

This property is read-only.

Data Type

String

DataConnInfoPFSCipher Property (FTPClient Component)

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

Syntax

__property bool DataConnInfoPFSCipher = { read=FDataConnInfoPFSCipher };

Default Value

false

Remarks

Indicates whether the chosen ciphersuite provides perfect forward secrecy (PFS).

This property is read-only.

Data Type

Boolean

DataConnInfoPreSharedIdentity Property (FTPClient Component)

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String DataConnInfoPreSharedIdentity = { read=FDataConnInfoPreSharedIdentity };

Default Value

""

Remarks

Specifies the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

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

Data Type

String

DataConnInfoPreSharedIdentityHint Property (FTPClient Component)

A hint professed by the server to help the client select the PSK identity to use.

Syntax

__property String DataConnInfoPreSharedIdentityHint = { read=FDataConnInfoPreSharedIdentityHint };

Default Value

""

Remarks

A hint professed by the server to help the client select the PSK identity to use.

This property is read-only.

Data Type

String

DataConnInfoPublicKeyBits Property (FTPClient Component)

The length of the public key.

Syntax

__property int DataConnInfoPublicKeyBits = { read=FDataConnInfoPublicKeyBits };

Default Value

0

Remarks

The length of the public key.

This property is read-only.

Data Type

Integer

DataConnInfoRemoteAddress Property (FTPClient Component)

The client's IP address.

Syntax

__property String DataConnInfoRemoteAddress = { read=FDataConnInfoRemoteAddress };

Default Value

""

Remarks

The client's IP address.

This property is read-only.

Data Type

String

DataConnInfoRemotePort Property (FTPClient Component)

The remote port of the client connection.

Syntax

__property int DataConnInfoRemotePort = { read=FDataConnInfoRemotePort };

Default Value

0

Remarks

The remote port of the client connection.

This property is read-only.

Data Type

Integer

DataConnInfoResumedSession Property (FTPClient Component)

Indicates whether a TLS-enabled connection was spawned from another TLS connection.

Syntax

__property bool DataConnInfoResumedSession = { read=FDataConnInfoResumedSession };

Default Value

false

Remarks

Indicates whether a TLS-enabled connection was spawned from another TLS connection

This property is read-only.

Data Type

Boolean

DataConnInfoSecureConnection Property (FTPClient Component)

Indicates whether TLS or SSL is enabled for this connection.

Syntax

__property bool DataConnInfoSecureConnection = { read=FDataConnInfoSecureConnection };

Default Value

false

Remarks

Indicates whether TLS or SSL is enabled for this connection.

This property is read-only.

Data Type

Boolean

DataConnInfoServerAuthenticated Property (FTPClient Component)

Indicates whether server authentication was performed during a TLS-enabled connection.

Syntax

__property bool DataConnInfoServerAuthenticated = { read=FDataConnInfoServerAuthenticated };

Default Value

false

Remarks

Indicates whether server authentication was performed during a TLS-enabled connection.

This property is read-only.

Data Type

Boolean

DataConnInfoSignatureAlgorithm Property (FTPClient Component)

The signature algorithm used in a TLS handshake.

Syntax

__property String DataConnInfoSignatureAlgorithm = { read=FDataConnInfoSignatureAlgorithm };

Default Value

""

Remarks

The signature algorithm used in a TLS handshake.

This property is read-only.

Data Type

String

DataConnInfoSymmetricBlockSize Property (FTPClient Component)

The block size of the symmetric algorithm used.

Syntax

__property int DataConnInfoSymmetricBlockSize = { read=FDataConnInfoSymmetricBlockSize };

Default Value

0

Remarks

The block size of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

DataConnInfoSymmetricKeyBits Property (FTPClient Component)

The key length of the symmetric algorithm used.

Syntax

__property int DataConnInfoSymmetricKeyBits = { read=FDataConnInfoSymmetricKeyBits };

Default Value

0

Remarks

The key length of the symmetric algorithm used.

This property is read-only.

Data Type

Integer

DataConnInfoTotalBytesReceived Property (FTPClient Component)

The total number of bytes received over this connection.

Syntax

__property __int64 DataConnInfoTotalBytesReceived = { read=FDataConnInfoTotalBytesReceived };

Default Value

0

Remarks

The total number of bytes received over this connection.

This property is read-only.

Data Type

Long64

DataConnInfoTotalBytesSent Property (FTPClient Component)

The total number of bytes sent over this connection.

Syntax

__property __int64 DataConnInfoTotalBytesSent = { read=FDataConnInfoTotalBytesSent };

Default Value

0

Remarks

The total number of bytes sent over this connection.

This property is read-only.

Data Type

Long64

DataConnInfoValidationLog Property (FTPClient Component)

Contains the server certificate's chain validation log.

Syntax

__property String DataConnInfoValidationLog = { read=FDataConnInfoValidationLog };

Default Value

""

Remarks

Contains the server certificate's chain validation log. This information may be very useful in investigating chain validation failures.

This property is read-only.

Data Type

String

DataConnInfoVersion Property (FTPClient Component)

Indicates the version of SSL/TLS protocol negotiated during this connection.

Syntax

__property String DataConnInfoVersion = { read=FDataConnInfoVersion };

Default Value

""

Remarks

Indicates the version of SSL/TLS protocol negotiated during this connection.

This property is read-only.

Data Type

String

EncryptDataChannel Property (FTPClient Component)

Enables or disables data channel encryption.

Syntax

__property bool EncryptDataChannel = { read=FEncryptDataChannel, write=FSetEncryptDataChannel };

Default Value

true

Remarks

Use this property to enable or disable data channel encryption. This property should be configured before Connect method is called.

Data Type

Boolean

ExternalCryptoAsyncDocumentID Property (FTPClient Component)

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Syntax

__property String ExternalCryptoAsyncDocumentID = { read=FExternalCryptoAsyncDocumentID, write=FSetExternalCryptoAsyncDocumentID };

Default Value

""

Remarks

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

Data Type

String

ExternalCryptoCustomParams Property (FTPClient Component)

Custom parameters to be passed to the signing service (uninterpreted).

Syntax

__property String ExternalCryptoCustomParams = { read=FExternalCryptoCustomParams, write=FSetExternalCryptoCustomParams };

Default Value

""

Remarks

Custom parameters to be passed to the signing service (uninterpreted).

This property is not available at design time.

Data Type

String

ExternalCryptoData Property (FTPClient Component)

Additional data to be included in the async state and mirrored back by the requestor.

Syntax

__property String ExternalCryptoData = { read=FExternalCryptoData, write=FSetExternalCryptoData };

Default Value

""

Remarks

Additional data to be included in the async state and mirrored back by the requestor.

This property is not available at design time.

Data Type

String

ExternalCryptoExternalHashCalculation Property (FTPClient Component)

Specifies whether the message hash is to be calculated at the external endpoint.

Syntax

__property bool ExternalCryptoExternalHashCalculation = { read=FExternalCryptoExternalHashCalculation, write=FSetExternalCryptoExternalHashCalculation };

Default Value

false

Remarks

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth component.

If set to true, the component will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

Data Type

Boolean

ExternalCryptoHashAlgorithm Property (FTPClient Component)

Specifies the request's signature hash algorithm.

Syntax

__property String ExternalCryptoHashAlgorithm = { read=FExternalCryptoHashAlgorithm, write=FSetExternalCryptoHashAlgorithm };

Default Value

"SHA256"

Remarks

Specifies the request's signature hash algorithm.

Data Type

String

ExternalCryptoKeyID Property (FTPClient Component)

The ID of the pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeyID = { read=FExternalCryptoKeyID, write=FSetExternalCryptoKeyID };

Default Value

""

Remarks

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use ExternalCryptoKeySecret to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

Data Type

String

ExternalCryptoKeySecret Property (FTPClient Component)

The pre-shared key used for DC request authentication.

Syntax

__property String ExternalCryptoKeySecret = { read=FExternalCryptoKeySecret, write=FSetExternalCryptoKeySecret };

Default Value

""

Remarks

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the ExternalCryptoKeyID topic.

Data Type

String

ExternalCryptoMethod Property (FTPClient Component)

Specifies the asynchronous signing method.

Syntax

__property TsbxFTPClientExternalCryptoMethods ExternalCryptoMethod = { read=FExternalCryptoMethod, write=FSetExternalCryptoMethod };

enum TsbxFTPClientExternalCryptoMethods {
  asmdPKCS1=0,
  asmdPKCS7=1
};

Default Value

asmdPKCS1

Remarks

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

Data Type

Integer

ExternalCryptoMode Property (FTPClient Component)

Specifies the external cryptography mode.

Syntax

__property TsbxFTPClientExternalCryptoModes ExternalCryptoMode = { read=FExternalCryptoMode, write=FSetExternalCryptoMode };

enum TsbxFTPClientExternalCryptoModes {
  ecmDefault=0,
  ecmDisabled=1,
  ecmGeneric=2,
  ecmDCAuth=3,
  ecmDCAuthJSON=4
};

Default Value

ecmDefault

Remarks

Specifies the external cryptography mode.

Available options:

This property is not available at design time.

Data Type

Integer

ExternalCryptoPublicKeyAlgorithm Property (FTPClient Component)

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Syntax

__property String ExternalCryptoPublicKeyAlgorithm = { read=FExternalCryptoPublicKeyAlgorithm, write=FSetExternalCryptoPublicKeyAlgorithm };

Default Value

""

Remarks

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

Data Type

String

FIPSMode Property (FTPClient Component)

Reserved.

Syntax

__property bool FIPSMode = { read=FFIPSMode, write=FSetFIPSMode };

Default Value

false

Remarks

This property is reserved for future use.

Data Type

Boolean

KnownCertCount Property (FTPClient Component)

The number of records in the KnownCert arrays.

Syntax

__property int KnownCertCount = { read=FKnownCertCount, write=FSetKnownCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCertBytes
• KnownCertHandle

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

This property is not available at design time.

Data Type

Integer

KnownCertBytes Property (FTPClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray KnownCertBytes[int KnownCertIndex] = { read=FKnownCertBytes };

Remarks

Returns the raw certificate data in DER format.

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

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

Data Type

Byte Array

KnownCertHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KnownCertHandle[int KnownCertIndex] = { read=FKnownCertHandle, write=FSetKnownCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCertCount property.

This property is not available at design time.

Data Type

Long64

KnownCRLCount Property (FTPClient Component)

The number of records in the KnownCRL arrays.

Syntax

__property int KnownCRLCount = { read=FKnownCRLCount, write=FSetKnownCRLCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownCRLBytes
• KnownCRLHandle

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

This property is not available at design time.

Data Type

Integer

KnownCRLBytes Property (FTPClient Component)

Returns the raw CRL data in DER format.

Syntax

__property DynamicArray KnownCRLBytes[int KnownCRLIndex] = { read=FKnownCRLBytes };

Remarks

Returns the raw CRL data in DER format.

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

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

Data Type

Byte Array

KnownCRLHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KnownCRLHandle[int KnownCRLIndex] = { read=FKnownCRLHandle, write=FSetKnownCRLHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownCRLIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownCRLCount property.

This property is not available at design time.

Data Type

Long64

KnownOCSPCount Property (FTPClient Component)

The number of records in the KnownOCSP arrays.

Syntax

__property int KnownOCSPCount = { read=FKnownOCSPCount, write=FSetKnownOCSPCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• KnownOCSPBytes
• KnownOCSPHandle

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

This property is not available at design time.

Data Type

Integer

KnownOCSPBytes Property (FTPClient Component)

A buffer containing the raw OCSP response data.

Syntax

__property DynamicArray KnownOCSPBytes[int KnownOCSPIndex] = { read=FKnownOCSPBytes };

Remarks

A buffer containing the raw OCSP response data.

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

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

Data Type

Byte Array

KnownOCSPHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 KnownOCSPHandle[int KnownOCSPIndex] = { read=FKnownOCSPHandle, write=FSetKnownOCSPHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The KnownOCSPIndex parameter specifies the index of the item in the array. The size of the array is controlled by the KnownOCSPCount property.

This property is not available at design time.

Data Type

Long64

ModeZ Property (FTPClient Component)

Switches on data compression.

Syntax

__property bool ModeZ = { read=FModeZ, write=FSetModeZ };

Default Value

true

Remarks

Switches the in-flight data compression on/off.

Data Type

Boolean

PassiveMode Property (FTPClient Component)

Enables or disables passive transfer mode.

Syntax

__property bool PassiveMode = { read=FPassiveMode, write=FSetPassiveMode };

Default Value

true

Remarks

The transfer mode (active or passive) regulates which party is responsible for opening a listening port for data connections. Where passive mode is used, the FTP server is responsible for listening for data connections. In active mode, the listening port is opened by the client.

In today's Internet of firewalls it is a de-facto standard to use the passive mode for FTP transfers.

Data Type

Boolean

Password Property (FTPClient Component)

The connecting user's authentication password.

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

Assign the user's authentication password to this property. Use Username for username/login.

Data Type

String

ProxyAddress Property (FTPClient Component)

The IP address of the proxy server.

Syntax

__property String ProxyAddress = { read=FProxyAddress, write=FSetProxyAddress };

Default Value

""

Remarks

The IP address of the proxy server.

Data Type

String

ProxyAuthentication Property (FTPClient Component)

The authentication type used by the proxy server.

Syntax

__property TsbxFTPClientProxyAuthentications ProxyAuthentication = { read=FProxyAuthentication, write=FSetProxyAuthentication };

enum TsbxFTPClientProxyAuthentications {
  patNoAuthentication=0,
  patBasic=1,
  patDigest=2,
  patNTLM=3
};

Default Value

patNoAuthentication

Remarks

The authentication type used by the proxy server.

Data Type

Integer

ProxyPassword Property (FTPClient Component)

The password to authenticate to the proxy server.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

The password to authenticate to the proxy server.

Data Type

String

ProxyPort Property (FTPClient Component)

The port on the proxy server to connect to.

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

0

Remarks

The port on the proxy server to connect to.

Data Type

Integer

ProxyProxyType Property (FTPClient Component)

The type of the proxy server.

Syntax

__property TsbxFTPClientProxyProxyTypes ProxyProxyType = { read=FProxyProxyType, write=FSetProxyProxyType };

enum TsbxFTPClientProxyProxyTypes {
  cptNone=0,
  cptSocks4=1,
  cptSocks5=2,
  cptWebTunnel=3,
  cptHTTP=4
};

Default Value

cptNone

Remarks

The type of the proxy server.

Data Type

Integer

ProxyRequestHeaders Property (FTPClient Component)

Contains HTTP request headers for WebTunnel and HTTP proxy.

Syntax

__property String ProxyRequestHeaders = { read=FProxyRequestHeaders, write=FSetProxyRequestHeaders };

Default Value

""

Remarks

Contains HTTP request headers for WebTunnel and HTTP proxy.

Data Type

String

ProxyResponseBody Property (FTPClient Component)

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Syntax

__property String ProxyResponseBody = { read=FProxyResponseBody, write=FSetProxyResponseBody };

Default Value

""

Remarks

Contains the HTTP or HTTPS (WebTunnel) proxy response body.

Data Type

String

ProxyResponseHeaders Property (FTPClient Component)

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Syntax

__property String ProxyResponseHeaders = { read=FProxyResponseHeaders, write=FSetProxyResponseHeaders };

Default Value

""

Remarks

Contains response headers received from an HTTP or HTTPS (WebTunnel) proxy server.

Data Type

String

ProxyUseIPv6 Property (FTPClient Component)

Specifies whether IPv6 should be used when connecting through the proxy.

Syntax

__property bool ProxyUseIPv6 = { read=FProxyUseIPv6, write=FSetProxyUseIPv6 };

Default Value

false

Remarks

Specifies whether IPv6 should be used when connecting through the proxy.

Data Type

Boolean

ProxyUsername Property (FTPClient Component)

Specifies the username credential for proxy authentication.

Syntax

__property String ProxyUsername = { read=FProxyUsername, write=FSetProxyUsername };

Default Value

""

Remarks

Specifies the username credential for proxy authentication.

Data Type

String

RestartAt Property (FTPClient Component)

The offset to restart the file transfer from.

Syntax

__property __int64 RestartAt = { read=FRestartAt, write=FSetRestartAt };

Default Value

-1

Remarks

If non-zero, tells the component to restart the file transfer operation at the specified position, rather than transfer the file in full.

Data Type

Long64

SocketDNSMode Property (FTPClient Component)

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Syntax

__property TsbxFTPClientSocketDNSModes SocketDNSMode = { read=FSocketDNSMode, write=FSetSocketDNSMode };

enum TsbxFTPClientSocketDNSModes {
  dmAuto=0,
  dmPlatform=1,
  dmOwn=2,
  dmOwnSecure=3
};

Default Value

dmAuto

Remarks

Selects the DNS resolver to use: the component's (secure) built-in one, or the one provided by the system.

Data Type

Integer

SocketDNSPort Property (FTPClient Component)

Specifies the port number to be used for sending queries to the DNS server.

Syntax

__property int SocketDNSPort = { read=FSocketDNSPort, write=FSetSocketDNSPort };

Default Value

0

Remarks

Specifies the port number to be used for sending queries to the DNS server.

Data Type

Integer

SocketDNSQueryTimeout Property (FTPClient Component)

The timeout (in milliseconds) for each DNS query.

Syntax

__property int SocketDNSQueryTimeout = { read=FSocketDNSQueryTimeout, write=FSetSocketDNSQueryTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for each DNS query. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketDNSServers Property (FTPClient Component)

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Syntax

__property String SocketDNSServers = { read=FSocketDNSServers, write=FSetSocketDNSServers };

Default Value

""

Remarks

The addresses of DNS servers to use for address resolution, separated by commas or semicolons.

Data Type

String

SocketDNSTotalTimeout Property (FTPClient Component)

The timeout (in milliseconds) for the whole resolution process.

Syntax

__property int SocketDNSTotalTimeout = { read=FSocketDNSTotalTimeout, write=FSetSocketDNSTotalTimeout };

Default Value

0

Remarks

The timeout (in milliseconds) for the whole resolution process. The value of 0 indicates an infinite timeout.

Data Type

Integer

SocketIncomingSpeedLimit Property (FTPClient Component)

The maximum number of bytes to read from the socket, per second.

Syntax

__property int SocketIncomingSpeedLimit = { read=FSocketIncomingSpeedLimit, write=FSetSocketIncomingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to read from the socket, per second.

Data Type

Integer

SocketLocalAddress Property (FTPClient Component)

The local network interface to bind the socket to.

Syntax

__property String SocketLocalAddress = { read=FSocketLocalAddress, write=FSetSocketLocalAddress };

Default Value

""

Remarks

The local network interface to bind the socket to.

Data Type

String

SocketLocalPort Property (FTPClient Component)

The local port number to bind the socket to.

Syntax

__property int SocketLocalPort = { read=FSocketLocalPort, write=FSetSocketLocalPort };

Default Value

0

Remarks

The local port number to bind the socket to.

Data Type

Integer

SocketOutgoingSpeedLimit Property (FTPClient Component)

The maximum number of bytes to write to the socket, per second.

Syntax

__property int SocketOutgoingSpeedLimit = { read=FSocketOutgoingSpeedLimit, write=FSetSocketOutgoingSpeedLimit };

Default Value

0

Remarks

The maximum number of bytes to write to the socket, per second.

Data Type

Integer

SocketTimeout Property (FTPClient Component)

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

Syntax

__property int SocketTimeout = { read=FSocketTimeout, write=FSetSocketTimeout };

Default Value

60000

Remarks

The maximum period of waiting, in milliseconds, after which the socket operation is considered unsuccessful.

If Timeout is set to 0, a socket operation will expire after the system-default timeout (2 hrs 8 min for TCP stack).

Data Type

Integer

SocketUseIPv6 Property (FTPClient Component)

Enables or disables IP protocol version 6.

Syntax

__property bool SocketUseIPv6 = { read=FSocketUseIPv6, write=FSetSocketUseIPv6 };

Default Value

false

Remarks

Enables or disables IP protocol version 6.

Data Type

Boolean

TLSClientCertCount Property (FTPClient Component)

The number of records in the TLSClientCert arrays.

Syntax

__property int TLSClientCertCount = { read=FTLSClientCertCount, write=FSetTLSClientCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSClientCertBytes
• TLSClientCertHandle

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

This property is not available at design time.

Data Type

Integer

TLSClientCertBytes Property (FTPClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TLSClientCertBytes[int TLSClientCertIndex] = { read=FTLSClientCertBytes };

Remarks

Returns the raw certificate data in DER format.

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

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

Data Type

Byte Array

TLSClientCertHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 TLSClientCertHandle[int TLSClientCertIndex] = { read=FTLSClientCertHandle, write=FSetTLSClientCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSClientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSClientCertCount property.

This property is not available at design time.

Data Type

Long64

TLSServerCertCount Property (FTPClient Component)

The number of records in the TLSServerCert arrays.

Syntax

__property int TLSServerCertCount = { read=FTLSServerCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TLSServerCertBytes
• TLSServerCertFingerprint
• TLSServerCertHandle
• TLSServerCertIssuer
• TLSServerCertIssuerRDN
• TLSServerCertKeyAlgorithm
• TLSServerCertKeyBits
• TLSServerCertKeyUsage
• TLSServerCertSelfSigned
• TLSServerCertSerialNumber
• TLSServerCertSigAlgorithm
• TLSServerCertSubject
• TLSServerCertSubjectRDN
• TLSServerCertValidFrom
• TLSServerCertValidTo

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

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

Data Type

Integer

TLSServerCertBytes Property (FTPClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TLSServerCertBytes[int TLSServerCertIndex] = { read=FTLSServerCertBytes };

Remarks

Returns the raw certificate data in DER format.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertFingerprint Property (FTPClient Component)

Contains the fingerprint (a hash imprint) of this certificate.

Syntax

__property String TLSServerCertFingerprint[int TLSServerCertIndex] = { read=FTLSServerCertFingerprint };

Default Value

""

Remarks

Contains the fingerprint (a hash imprint) of this certificate.

While there is no formal standard defining what a fingerprint is, a SHA1 hash of the certificate's DER-encoded body is typically used.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 TLSServerCertHandle[int TLSServerCertIndex] = { read=FTLSServerCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Long64

TLSServerCertIssuer Property (FTPClient Component)

The common name of the certificate issuer (CA), typically a company name.

Syntax

__property String TLSServerCertIssuer[int TLSServerCertIndex] = { read=FTLSServerCertIssuer };

Default Value

""

Remarks

The common name of the certificate issuer (CA), typically a company name. This is part of a larger set of credentials available via TLSIssuerRDN.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertIssuerRDN Property (FTPClient Component)

A list of Property=Value pairs that uniquely identify the certificate issuer.

Syntax

__property String TLSServerCertIssuerRDN[int TLSServerCertIndex] = { read=FTLSServerCertIssuerRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate issuer.

Example: /C=US/O=Nationwide CA/CN=Web Certification Authority

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertKeyAlgorithm Property (FTPClient Component)

Specifies the public key algorithm of this certificate.

Syntax

__property String TLSServerCertKeyAlgorithm[int TLSServerCertIndex] = { read=FTLSServerCertKeyAlgorithm };

Default Value

"0"

Remarks

Specifies the public key algorithm of this certificate.

Use the TLSKeyBits, TLSCurve, and TLSPublicKeyBytes properties to get more details about the key the certificate contains.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertKeyBits Property (FTPClient Component)

Returns the length of the public key in bits.

Syntax

__property int TLSServerCertKeyBits[int TLSServerCertIndex] = { read=FTLSServerCertKeyBits };

Default Value

0

Remarks

Returns the length of the public key in bits.

This value indicates the length of the principal cryptographic parameter of the key, such as the length of the RSA modulus or ECDSA field. The key data returned by the TLSPublicKeyBytes or TLSPrivateKeyBytes property would typically contain auxiliary values, and therefore be longer.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Integer

TLSServerCertKeyUsage Property (FTPClient Component)

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

Syntax

__property int TLSServerCertKeyUsage[int TLSServerCertIndex] = { read=FTLSServerCertKeyUsage };

Default Value

0

Remarks

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

Set this property before generating the certificate to propagate the key usage flags to the new certificate.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Integer

TLSServerCertSelfSigned Property (FTPClient Component)

Indicates whether the certificate is self-signed (root) or signed by an external CA.

Syntax

__property bool TLSServerCertSelfSigned[int TLSServerCertIndex] = { read=FTLSServerCertSelfSigned };

Default Value

false

Remarks

Indicates whether the certificate is self-signed (root) or signed by an external CA.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Boolean

TLSServerCertSerialNumber Property (FTPClient Component)

Returns the certificate's serial number.

Syntax

__property DynamicArray TLSServerCertSerialNumber[int TLSServerCertIndex] = { read=FTLSServerCertSerialNumber };

Remarks

Returns the certificate's serial number.

The serial number is a binary string that uniquely identifies a certificate among others issued by the same CA. According to the X.509 standard, the (issuer, serial number) pair should be globally unique to facilitate chain building.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

Byte Array

TLSServerCertSigAlgorithm Property (FTPClient Component)

Indicates the algorithm that was used by the CA to sign this certificate.

Syntax

__property String TLSServerCertSigAlgorithm[int TLSServerCertIndex] = { read=FTLSServerCertSigAlgorithm };

Default Value

""

Remarks

Indicates the algorithm that was used by the CA to sign this certificate.

A signature algorithm typically combines hash and public key algorithms together, such as sha256WithRSAEncryption or ecdsa-with-SHA256.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertSubject Property (FTPClient Component)

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

Syntax

__property String TLSServerCertSubject[int TLSServerCertIndex] = { read=FTLSServerCertSubject };

Default Value

""

Remarks

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name. This is part of a larger set of credentials available via TLSSubjectRDN.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertSubjectRDN Property (FTPClient Component)

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Syntax

__property String TLSServerCertSubjectRDN[int TLSServerCertIndex] = { read=FTLSServerCertSubjectRDN };

Default Value

""

Remarks

A list of Property=Value pairs that uniquely identify the certificate holder (subject).

Depending on the purpose of the certificate and the policies of the CA that issued it, the values included in the subject record may differ drastically and contain business or personal names, web URLs, email addresses, and other data.

Example: /C=US/O=Oranges and Apples, Inc./OU=Accounts Receivable/1.2.3.4.5=Value with unknown OID/CN=Margaret Watkins.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertValidFrom Property (FTPClient Component)

The time point at which the certificate becomes valid, in UTC.

Syntax

__property String TLSServerCertValidFrom[int TLSServerCertIndex] = { read=FTLSServerCertValidFrom };

Default Value

""

Remarks

The time point at which the certificate becomes valid, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSServerCertValidTo Property (FTPClient Component)

The time point at which the certificate expires, in UTC.

Syntax

__property String TLSServerCertValidTo[int TLSServerCertIndex] = { read=FTLSServerCertValidTo };

Default Value

""

Remarks

The time point at which the certificate expires, in UTC.

The TLSServerCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TLSServerCertCount property.

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

Data Type

String

TLSAutoValidateCertificates Property (FTPClient Component)

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Syntax

__property bool TLSAutoValidateCertificates = { read=FTLSAutoValidateCertificates, write=FSetTLSAutoValidateCertificates };

Default Value

true

Remarks

Specifies whether server-side TLS certificates should be validated automatically using internal validation rules.

Data Type

Boolean

TLSBaseConfiguration Property (FTPClient Component)

Selects the base configuration for the TLS settings.

Syntax

__property TsbxFTPClientTLSBaseConfigurations TLSBaseConfiguration = { read=FTLSBaseConfiguration, write=FSetTLSBaseConfiguration };

enum TsbxFTPClientTLSBaseConfigurations {
  stpcDefault=0,
  stpcCompatible=1,
  stpcComprehensiveInsecure=2,
  stpcHighlySecure=3
};

Default Value

stpcDefault

Remarks

Selects the base configuration for the TLS settings. Several profiles are offered and tuned up for different purposes, such as high security or higher compatibility.

Data Type

Integer

TLSCiphersuites Property (FTPClient Component)

A list of ciphersuites separated with commas or semicolons.

Syntax

__property String TLSCiphersuites = { read=FTLSCiphersuites, write=FSetTLSCiphersuites };

Default Value

""

Remarks

A list of ciphersuites separated with commas or semicolons. Each ciphersuite in the list may be prefixed with a minus sign (-) to indicate that the ciphersuite should be disabled rather than enabled. Besides the specific ciphersuite modifiers, this property supports the all (and -all) aliases, allowing all ciphersuites to be blanketly enabled or disabled at once.

Note: the list of ciphersuites provided to this property alters the baseline list of ciphersuites as defined by TLSBaseConfiguration. Remember to start your ciphersuite string with -all; if you need to only enable a specific fixed set of ciphersuites. The list of supported ciphersuites is provided below:

• NULL_NULL_NULL
• RSA_NULL_MD5
• RSA_NULL_SHA
• RSA_RC4_MD5
• RSA_RC4_SHA
• RSA_RC2_MD5
• RSA_IDEA_MD5
• RSA_IDEA_SHA
• RSA_DES_MD5
• RSA_DES_SHA
• RSA_3DES_MD5
• RSA_3DES_SHA
• RSA_AES128_SHA
• RSA_AES256_SHA
• DH_DSS_DES_SHA
• DH_DSS_3DES_SHA
• DH_DSS_AES128_SHA
• DH_DSS_AES256_SHA
• DH_RSA_DES_SHA
• DH_RSA_3DES_SHA
• DH_RSA_AES128_SHA
• DH_RSA_AES256_SHA
• DHE_DSS_DES_SHA
• DHE_DSS_3DES_SHA
• DHE_DSS_AES128_SHA
• DHE_DSS_AES256_SHA
• DHE_RSA_DES_SHA
• DHE_RSA_3DES_SHA
• DHE_RSA_AES128_SHA
• DHE_RSA_AES256_SHA
• DH_ANON_RC4_MD5
• DH_ANON_DES_SHA
• DH_ANON_3DES_SHA
• DH_ANON_AES128_SHA
• DH_ANON_AES256_SHA
• RSA_RC2_MD5_EXPORT
• RSA_RC4_MD5_EXPORT
• RSA_DES_SHA_EXPORT
• DH_DSS_DES_SHA_EXPORT
• DH_RSA_DES_SHA_EXPORT
• DHE_DSS_DES_SHA_EXPORT
• DHE_RSA_DES_SHA_EXPORT
• DH_ANON_RC4_MD5_EXPORT
• DH_ANON_DES_SHA_EXPORT
• RSA_CAMELLIA128_SHA
• DH_DSS_CAMELLIA128_SHA
• DH_RSA_CAMELLIA128_SHA
• DHE_DSS_CAMELLIA128_SHA
• DHE_RSA_CAMELLIA128_SHA
• DH_ANON_CAMELLIA128_SHA
• RSA_CAMELLIA256_SHA
• DH_DSS_CAMELLIA256_SHA
• DH_RSA_CAMELLIA256_SHA
• DHE_DSS_CAMELLIA256_SHA
• DHE_RSA_CAMELLIA256_SHA
• DH_ANON_CAMELLIA256_SHA
• PSK_RC4_SHA
• PSK_3DES_SHA
• PSK_AES128_SHA
• PSK_AES256_SHA
• DHE_PSK_RC4_SHA
• DHE_PSK_3DES_SHA
• DHE_PSK_AES128_SHA
• DHE_PSK_AES256_SHA
• RSA_PSK_RC4_SHA
• RSA_PSK_3DES_SHA
• RSA_PSK_AES128_SHA
• RSA_PSK_AES256_SHA
• RSA_SEED_SHA
• DH_DSS_SEED_SHA
• DH_RSA_SEED_SHA
• DHE_DSS_SEED_SHA
• DHE_RSA_SEED_SHA
• DH_ANON_SEED_SHA
• SRP_SHA_3DES_SHA
• SRP_SHA_RSA_3DES_SHA
• SRP_SHA_DSS_3DES_SHA
• SRP_SHA_AES128_SHA
• SRP_SHA_RSA_AES128_SHA
• SRP_SHA_DSS_AES128_SHA
• SRP_SHA_AES256_SHA
• SRP_SHA_RSA_AES256_SHA
• SRP_SHA_DSS_AES256_SHA
• ECDH_ECDSA_NULL_SHA
• ECDH_ECDSA_RC4_SHA
• ECDH_ECDSA_3DES_SHA
• ECDH_ECDSA_AES128_SHA
• ECDH_ECDSA_AES256_SHA
• ECDHE_ECDSA_NULL_SHA
• ECDHE_ECDSA_RC4_SHA
• ECDHE_ECDSA_3DES_SHA
• ECDHE_ECDSA_AES128_SHA
• ECDHE_ECDSA_AES256_SHA
• ECDH_RSA_NULL_SHA
• ECDH_RSA_RC4_SHA
• ECDH_RSA_3DES_SHA
• ECDH_RSA_AES128_SHA
• ECDH_RSA_AES256_SHA
• ECDHE_RSA_NULL_SHA
• ECDHE_RSA_RC4_SHA
• ECDHE_RSA_3DES_SHA
• ECDHE_RSA_AES128_SHA
• ECDHE_RSA_AES256_SHA
• ECDH_ANON_NULL_SHA
• ECDH_ANON_RC4_SHA
• ECDH_ANON_3DES_SHA
• ECDH_ANON_AES128_SHA
• ECDH_ANON_AES256_SHA
• RSA_NULL_SHA256
• RSA_AES128_SHA256
• RSA_AES256_SHA256
• DH_DSS_AES128_SHA256
• DH_RSA_AES128_SHA256
• DHE_DSS_AES128_SHA256
• DHE_RSA_AES128_SHA256
• DH_DSS_AES256_SHA256
• DH_RSA_AES256_SHA256
• DHE_DSS_AES256_SHA256
• DHE_RSA_AES256_SHA256
• DH_ANON_AES128_SHA256
• DH_ANON_AES256_SHA256
• RSA_AES128_GCM_SHA256
• RSA_AES256_GCM_SHA384
• DHE_RSA_AES128_GCM_SHA256
• DHE_RSA_AES256_GCM_SHA384
• DH_RSA_AES128_GCM_SHA256
• DH_RSA_AES256_GCM_SHA384
• DHE_DSS_AES128_GCM_SHA256
• DHE_DSS_AES256_GCM_SHA384
• DH_DSS_AES128_GCM_SHA256
• DH_DSS_AES256_GCM_SHA384
• DH_ANON_AES128_GCM_SHA256
• DH_ANON_AES256_GCM_SHA384
• ECDHE_ECDSA_AES128_SHA256
• ECDHE_ECDSA_AES256_SHA384
• ECDH_ECDSA_AES128_SHA256
• ECDH_ECDSA_AES256_SHA384
• ECDHE_RSA_AES128_SHA256
• ECDHE_RSA_AES256_SHA384
• ECDH_RSA_AES128_SHA256
• ECDH_RSA_AES256_SHA384
• ECDHE_ECDSA_AES128_GCM_SHA256
• ECDHE_ECDSA_AES256_GCM_SHA384
• ECDH_ECDSA_AES128_GCM_SHA256
• ECDH_ECDSA_AES256_GCM_SHA384
• ECDHE_RSA_AES128_GCM_SHA256
• ECDHE_RSA_AES256_GCM_SHA384
• ECDH_RSA_AES128_GCM_SHA256
• ECDH_RSA_AES256_GCM_SHA384
• PSK_AES128_GCM_SHA256
• PSK_AES256_GCM_SHA384
• DHE_PSK_AES128_GCM_SHA256
• DHE_PSK_AES256_GCM_SHA384
• RSA_PSK_AES128_GCM_SHA256
• RSA_PSK_AES256_GCM_SHA384
• PSK_AES128_SHA256
• PSK_AES256_SHA384
• PSK_NULL_SHA256
• PSK_NULL_SHA384
• DHE_PSK_AES128_SHA256
• DHE_PSK_AES256_SHA384
• DHE_PSK_NULL_SHA256
• DHE_PSK_NULL_SHA384
• RSA_PSK_AES128_SHA256
• RSA_PSK_AES256_SHA384
• RSA_PSK_NULL_SHA256
• RSA_PSK_NULL_SHA384
• RSA_CAMELLIA128_SHA256
• DH_DSS_CAMELLIA128_SHA256
• DH_RSA_CAMELLIA128_SHA256
• DHE_DSS_CAMELLIA128_SHA256
• DHE_RSA_CAMELLIA128_SHA256
• DH_ANON_CAMELLIA128_SHA256
• RSA_CAMELLIA256_SHA256
• DH_DSS_CAMELLIA256_SHA256
• DH_RSA_CAMELLIA256_SHA256
• DHE_DSS_CAMELLIA256_SHA256
• DHE_RSA_CAMELLIA256_SHA256
• DH_ANON_CAMELLIA256_SHA256
• ECDHE_ECDSA_CAMELLIA128_SHA256
• ECDHE_ECDSA_CAMELLIA256_SHA384
• ECDH_ECDSA_CAMELLIA128_SHA256
• ECDH_ECDSA_CAMELLIA256_SHA384
• ECDHE_RSA_CAMELLIA128_SHA256
• ECDHE_RSA_CAMELLIA256_SHA384
• ECDH_RSA_CAMELLIA128_SHA256
• ECDH_RSA_CAMELLIA256_SHA384
• RSA_CAMELLIA128_GCM_SHA256
• RSA_CAMELLIA256_GCM_SHA384
• DHE_RSA_CAMELLIA128_GCM_SHA256
• DHE_RSA_CAMELLIA256_GCM_SHA384
• DH_RSA_CAMELLIA128_GCM_SHA256
• DH_RSA_CAMELLIA256_GCM_SHA384
• DHE_DSS_CAMELLIA128_GCM_SHA256
• DHE_DSS_CAMELLIA256_GCM_SHA384
• DH_DSS_CAMELLIA128_GCM_SHA256
• DH_DSS_CAMELLIA256_GCM_SHA384
• DH_anon_CAMELLIA128_GCM_SHA256
• DH_anon_CAMELLIA256_GCM_SHA384
• ECDHE_ECDSA_CAMELLIA128_GCM_SHA256
• ECDHE_ECDSA_CAMELLIA256_GCM_SHA384
• ECDH_ECDSA_CAMELLIA128_GCM_SHA256
• ECDH_ECDSA_CAMELLIA256_GCM_SHA384
• ECDHE_RSA_CAMELLIA128_GCM_SHA256
• ECDHE_RSA_CAMELLIA256_GCM_SHA384
• ECDH_RSA_CAMELLIA128_GCM_SHA256
• ECDH_RSA_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_GCM_SHA256
• PSK_CAMELLIA256_GCM_SHA384
• DHE_PSK_CAMELLIA128_GCM_SHA256
• DHE_PSK_CAMELLIA256_GCM_SHA384
• RSA_PSK_CAMELLIA128_GCM_SHA256
• RSA_PSK_CAMELLIA256_GCM_SHA384
• PSK_CAMELLIA128_SHA256
• PSK_CAMELLIA256_SHA384
• DHE_PSK_CAMELLIA128_SHA256
• DHE_PSK_CAMELLIA256_SHA384
• RSA_PSK_CAMELLIA128_SHA256
• RSA_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_CAMELLIA128_SHA256
• ECDHE_PSK_CAMELLIA256_SHA384
• ECDHE_PSK_RC4_SHA
• ECDHE_PSK_3DES_SHA
• ECDHE_PSK_AES128_SHA
• ECDHE_PSK_AES256_SHA
• ECDHE_PSK_AES128_SHA256
• ECDHE_PSK_AES256_SHA384
• ECDHE_PSK_NULL_SHA
• ECDHE_PSK_NULL_SHA256
• ECDHE_PSK_NULL_SHA384
• ECDHE_RSA_CHACHA20_POLY1305_SHA256
• ECDHE_ECDSA_CHACHA20_POLY1305_SHA256
• DHE_RSA_CHACHA20_POLY1305_SHA256
• PSK_CHACHA20_POLY1305_SHA256
• ECDHE_PSK_CHACHA20_POLY1305_SHA256
• DHE_PSK_CHACHA20_POLY1305_SHA256
• RSA_PSK_CHACHA20_POLY1305_SHA256
• AES128_GCM_SHA256
• AES256_GCM_SHA384
• CHACHA20_POLY1305_SHA256
• AES128_CCM_SHA256
• AES128_CCM8_SHA256

Data Type

String

TLSClientAuth Property (FTPClient Component)

Enables or disables certificate-based client authentication.

Syntax

__property TsbxFTPClientTLSClientAuths TLSClientAuth = { read=FTLSClientAuth, write=FSetTLSClientAuth };

enum TsbxFTPClientTLSClientAuths {
  ccatNoAuth=0,
  ccatRequestCert=1,
  ccatRequireCert=2
};

Default Value

ccatNoAuth

Remarks

Enables or disables certificate-based client authentication.

Set this property to true to tune up the client authentication type:

Data Type

Integer

TLSECCurves Property (FTPClient Component)

Defines the elliptic curves to enable.

Syntax

__property String TLSECCurves = { read=FTLSECCurves, write=FSetTLSECCurves };

Default Value

""

Remarks

Defines the elliptic curves to enable.

Data Type

String

TLSExtensions Property (FTPClient Component)

Provides access to TLS extensions.

Syntax

__property String TLSExtensions = { read=FTLSExtensions, write=FSetTLSExtensions };

Default Value

""

Remarks

Provides access to TLS extensions.

Data Type

String

TLSForceResumeIfDestinationChanges Property (FTPClient Component)

Whether to force TLS session resumption when the destination address changes.

Syntax

__property bool TLSForceResumeIfDestinationChanges = { read=FTLSForceResumeIfDestinationChanges, write=FSetTLSForceResumeIfDestinationChanges };

Default Value

false

Remarks

Whether to force TLS session resumption when the destination address changes.

Data Type

Boolean

TLSPreSharedIdentity Property (FTPClient Component)

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

Syntax

__property String TLSPreSharedIdentity = { read=FTLSPreSharedIdentity, write=FSetTLSPreSharedIdentity };

Default Value

""

Remarks

Defines the identity used when the PSK (Pre-Shared Key) key-exchange mechanism is negotiated.

This property is not available at design time.

Data Type

String

TLSPreSharedKey Property (FTPClient Component)

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

Syntax

__property String TLSPreSharedKey = { read=FTLSPreSharedKey, write=FSetTLSPreSharedKey };

Default Value

""

Remarks

Contains the pre-shared key for the PSK (Pre-Shared Key) key-exchange mechanism, encoded with base16.

This property is not available at design time.

Data Type

String

TLSPreSharedKeyCiphersuite Property (FTPClient Component)

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Syntax

__property String TLSPreSharedKeyCiphersuite = { read=FTLSPreSharedKeyCiphersuite, write=FSetTLSPreSharedKeyCiphersuite };

Default Value

""

Remarks

Defines the ciphersuite used for PSK (Pre-Shared Key) negotiation.

Data Type

String

TLSRenegotiationAttackPreventionMode Property (FTPClient Component)

Selects the renegotiation attack prevention mechanism.

Syntax

__property TsbxFTPClientTLSRenegotiationAttackPreventionModes TLSRenegotiationAttackPreventionMode = { read=FTLSRenegotiationAttackPreventionMode, write=FSetTLSRenegotiationAttackPreventionMode };

enum TsbxFTPClientTLSRenegotiationAttackPreventionModes {
  crapmCompatible=0,
  crapmStrict=1,
  crapmAuto=2
};

Default Value

crapmAuto

Remarks

Selects the renegotiation attack prevention mechanism.

The following options are available:

Data Type

Integer

TLSRevocationCheck Property (FTPClient Component)

Specifies the kind(s) of revocation check to perform.

Syntax

__property TsbxFTPClientTLSRevocationChecks TLSRevocationCheck = { read=FTLSRevocationCheck, write=FSetTLSRevocationCheck };

enum TsbxFTPClientTLSRevocationChecks {
  crcNone=0,
  crcAuto=1,
  crcAllCRL=2,
  crcAllOCSP=3,
  crcAllCRLAndOCSP=4,
  crcAnyCRL=5,
  crcAnyOCSP=6,
  crcAnyCRLOrOCSP=7,
  crcAnyOCSPOrCRL=8
};

Default Value

crcAuto

Remarks

Specifies the kind(s) of revocation check to perform.

Revocation checking is necessary to ensure the integrity of the chain and obtain up-to-date certificate validity and trustworthiness information.

This setting controls the way the revocation checks are performed for every certificate in the chain. Typically certificates come with two types of revocation information sources: CRL (certificate revocation lists) and OCSP responders. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally some delay between the time when a certificate was revoked and the time the subsequent CRL mentioning that is published. The benefits of CRL is that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This setting lets you adjust the validation course by including or excluding certain types of revocation sources from the validation process. The crcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The "crcAll*" modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

Note: If no CRL or OCSP endpoints are provided by the CA, the revocation check will be considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

Note: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

This property is not available at design time.

Data Type

Integer

TLSSSLOptions Property (FTPClient Component)

Various SSL (TLS) protocol options, set of cssloExpectShutdownMessage 0x001 Wait for the close-notify message when shutting down the connection cssloOpenSSLDTLSWorkaround 0x002 (DEPRECATED) Use a DTLS version workaround when talking to very old OpenSSL versions cssloDisableKexLengthAlignment 0x004 Do not align the client-side PMS by the RSA modulus size.

Syntax

__property int TLSSSLOptions = { read=FTLSSSLOptions, write=FSetTLSSSLOptions };

Default Value

16

Remarks

Various SSL (TLS) protocol options, set of

Data Type

Integer

TLSTLSMode Property (FTPClient Component)

Specifies the TLS mode to use.

Syntax

__property TsbxFTPClientTLSTLSModes TLSTLSMode = { read=FTLSTLSMode, write=FSetTLSTLSMode };

enum TsbxFTPClientTLSTLSModes {
  smDefault=0,
  smNoTLS=1,
  smExplicitTLS=2,
  smImplicitTLS=3,
  smMixedTLS=4
};

Default Value

smDefault

Remarks

Specifies the TLS mode to use.

Data Type

Integer

TLSUseExtendedMasterSecret Property (FTPClient Component)

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Syntax

__property bool TLSUseExtendedMasterSecret = { read=FTLSUseExtendedMasterSecret, write=FSetTLSUseExtendedMasterSecret };

Default Value

false

Remarks

Enables the Extended Master Secret Extension, as defined in RFC 7627.

Data Type

Boolean

TLSUseSessionResumption Property (FTPClient Component)

Enables or disables the TLS session resumption capability.

Syntax

__property bool TLSUseSessionResumption = { read=FTLSUseSessionResumption, write=FSetTLSUseSessionResumption };

Default Value

false

Remarks

Enables or disables the TLS session resumption capability.

Data Type

Boolean

TLSVersions Property (FTPClient Component)

The SSL/TLS versions to enable by default.

Syntax

__property int TLSVersions = { read=FTLSVersions, write=FSetTLSVersions };

Default Value

16

Remarks

The SSL/TLS versions to enable by default.

Data Type

Integer

TransferType Property (FTPClient Component)

Sets the file transfer mode.

Syntax

__property TsbxFTPClientTransferTypes TransferType = { read=FTransferType, write=FSetTransferType };

enum TsbxFTPClientTransferTypes {
  cttText=0,
  cttBinary=1
};

Default Value

cttBinary

Remarks

Use this property to switch between binary and text transfer modes.

Data Type

Integer

TrustedCertCount Property (FTPClient Component)

The number of records in the TrustedCert arrays.

Syntax

__property int TrustedCertCount = { read=FTrustedCertCount, write=FSetTrustedCertCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertBytes
• TrustedCertHandle

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

This property is not available at design time.

Data Type

Integer

TrustedCertBytes Property (FTPClient Component)

Returns the raw certificate data in DER format.

Syntax

__property DynamicArray TrustedCertBytes[int TrustedCertIndex] = { read=FTrustedCertBytes };

Remarks

Returns the raw certificate data in DER format.

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

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

Data Type

Byte Array

TrustedCertHandle Property (FTPClient Component)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

__property __int64 TrustedCertHandle[int TrustedCertIndex] = { read=FTrustedCertHandle, write=FSetTrustedCertHandle };

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The TrustedCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Long64

Username Property (FTPClient Component)

The connecting user's username (login name).

Syntax

__property String Username = { read=FUsername, write=FSetUsername };

Default Value

""

Remarks

Assign the user's login name to this property. Use Password to provide the password.

Data Type

String

Abort Method (FTPClient Component)

Aborts the previous FTP service command and any associated transfer of data.

Syntax

void __fastcall Abort();

Remarks

Use this method to abort the previous FTP service command and any associated data transfer.

Acct Method (FTPClient Component)

Sends an Account command.

Syntax

void __fastcall Acct(String AcctInfo);

Remarks

Some servers require the ACCT command to be sent after signing in to grant access to specific server resources.

Reply codes sometimes allow to differentiate the handling of ACCT command:

• when account information is required for login, the response to a successful PASSword command is reply code 332;
• if account information is NOT required for login, the reply to a successful PASSword command is 230;
• if account information is needed for a command issued later in the dialogue, the server should return a 332 or 532 reply depending on whether it stores (pending receipt of the ACCounT command) or discards the command, respectively.

AppendBytes Method (FTPClient Component)

Appends a byte array to a server-side file.

Syntax

void __fastcall AppendBytes(DynamicArray<Byte> Bytes, String RemoteFile);

Remarks

Use this method to append Bytes to RemoteFile on the server.

AppendFile Method (FTPClient Component)

Uploads a file to the server.

Syntax

void __fastcall AppendFile(String LocalFile, String RemoteFile);

Remarks

Use this method to upload LocalFile or its part to RemoteFile on the server.

ChangeDir Method (FTPClient Component)

Changes the current directory.

Syntax

void __fastcall ChangeDir(String RemoteDir);

Remarks

Call this method to change the current server directory to RemoteDir.

ClearCommandChannel Method (FTPClient Component)

Sends CCC (Clear Command Channel) command to the server.

Syntax

void __fastcall ClearCommandChannel(bool GracefulSSLClosure);

Remarks

Use this method to send a CCC command. CCC clears command channel encryption state, turning off TLS encryption.

Some servers expect this command to allow for the control channel to be properly handled by NATs.

Config Method (FTPClient 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.

Connect Method (FTPClient Component)

Connects to the FTP server.

Syntax

void __fastcall Connect(String Address, int Port);

Remarks

Call this method to connect to the FTP server residing at Address:Port.

The component will connect to the server using the connection settings provided. If the connection is successful, it will also authenticate using the provided Username and Password.

DelDir Method (FTPClient Component)

Deletes a directory on the server.

Syntax

void __fastcall DelDir(String RemoteDir);

Remarks

DelFile Method (FTPClient Component)

Deletes a file on the server.

Syntax

void __fastcall DelFile(String RemoteFile);

Remarks

DirExists Method (FTPClient Component)

Checks if a directory exists on the server.

Syntax

bool __fastcall DirExists(String RemoteDir);

Remarks

Use this method to check if the RemoteDir exists on the server.

The test is performed by attempting to change the current directory to RemoteDir, and checking the response code returned by the server.

Note that this method will return false if the directory does exist but is not accessible for the client (e.g. due to a permission issue).

Disconnect Method (FTPClient Component)

Disconnects from the server.

Syntax

void __fastcall Disconnect();

Remarks

Call this method to disconnect from the server.

DoAction Method (FTPClient Component)

Performs an additional action.

Syntax

String __fastcall DoAction(String ActionID, String ActionParams);

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

DownloadBytes Method (FTPClient Component)

Downloads a file from the server into an array of bytes.

Syntax

DynamicArray<Byte> __fastcall DownloadBytes(String RemoteFile);

Remarks

Use this method to download RemoteFile into a byte array.

DownloadFile Method (FTPClient Component)

Downloads a file from the server.

Syntax

void __fastcall DownloadFile(String RemoteFile, String LocalFile);

Remarks

Use this method to download RemoteFile into LocalFile.

DownloadFiles Method (FTPClient Component)

Downloads multiple files from the server.

Syntax

void __fastcall DownloadFiles(String RemotePath, String LocalDir, bool Recursive, int ErrorHandling);

Remarks

Use this method do download a collection of files from the server.

RemotePath can contain a simple mask, a set of masks, or a regular expression. All the files that match the provided rule will be downloaded to LocalDir. The Recursive parameter tells the component whether it should navigate source directories recursively when downloading files. If set to false, only the files residing in the actual RemotePath, but not its subdirectories, will be downloaded.

The ErrorHandling parameter specifies one of the pre-defined error handling tactics:

FileExists Method (FTPClient Component)

Checks if a file exists on the server.

Syntax

bool __fastcall FileExists(String RemoteFile);

Remarks

Use this method to check if RemoteFile exists in the current remote directory. This method attempts to detect file existence using SIZE and MLST commands first, and falls back to LIST command if they are not available.

Please note that this command only looks for the file in the current directory. To check for existence of a file in a different directory, change to it with ChangeDir command first, then call this method.

GetCurrentDir Method (FTPClient Component)

Returns the server-side current directory.

Syntax

String __fastcall GetCurrentDir();

Remarks

Use this method to find out the current directory on the server.

GetFileSize Method (FTPClient Component)

Returns the size of a remote file.

Syntax

__int64 __fastcall GetFileSize(String RemoteFile);

Remarks

Use this method to retrieve the size of a remote file. This method attempts to use SIZE and MLST commands if available, and resorts to LIST command otherwise.

Please note that this command only looks for the file in the current directory. To check for existence of a file in a different directory, change to it with ChangeDir command first, then call this method.

ListDir Method (FTPClient Component)

Lists the contents of a remote directory.

Syntax

String __fastcall ListDir(bool IncludeFiles, bool IncludeDirectories);

Remarks

Use the IncludeFiles and IncludeDirectories parameters to tune up the output. The output of IncludeFiles also includes symbolic links.

This method returns a human-readable string containing the requested list. It also fires ListEntry for each entry in the list, propagating its details in CurrentListEntry.

This method uses some heuristics internally by choosing the most appropriate listing method among MLSD, NLST, and LIST.

MakeDir Method (FTPClient Component)

Creates a new directory on the server.

Syntax

void __fastcall MakeDir(String RemoteDir);

Remarks

This method creates a directory. The path provided via RemoteDir can either be absolute or relative.

Depending on the server, the directory structure up to the innermost element might need to exist.

Noop Method (FTPClient Component)

Sends a NOOP command to the server.

Syntax

void __fastcall Noop();

Remarks

Call this method to send a NOOP (No Operation) command to the server.

Rename Method (FTPClient Component)

Renames a file.

Syntax

void __fastcall Rename(String SourceFile, String DestFile);

Remarks

Use this method to rename a server-side SourceFile to DestFile.

Reset Method (FTPClient Component)

Resets the component settings.

Syntax

void __fastcall Reset();

Remarks

Reset is a generic method available in every component.

SendCommand Method (FTPClient Component)

Sends a custom command to the server.

Syntax

int __fastcall SendCommand(String Command);

Remarks

This method sends an arbitrary command to the server and returns the status code received. Use it to send custom or non-standard commands, or tune up the session flow as required by the server.

UploadBytes Method (FTPClient Component)

Uploads a byte array to the server.

Syntax

void __fastcall UploadBytes(DynamicArray<Byte> Bytes, String RemoteFile);

Remarks

Use this method to upload Bytes or its part to RemoteFile on the server.

UploadFile Method (FTPClient Component)

Uploads a file to the server.

Syntax

void __fastcall UploadFile(String LocalFile, String RemoteFile);

Remarks

Use this method to upload LocalFile or its part to RemoteFile on the server.

UploadFiles Method (FTPClient Component)

Uploads multiple files to the server.

Syntax

void __fastcall UploadFiles(String LocalPath, String RemoteDir, bool Recursive, int ErrorHandling);

Remarks

This method uploads all the files that match the LocalPath criteria to RemoteDir directory on the server. LocalPath accepts a simple mask, a set of masks, or a regular expression. The Recursive parameter tells the component whether it should navigate source directories recursively when uploading files. If set to false, only the files residing in the actual LocalPath, but not its subdirectories, will be uploaded.

The ErrorHandling parameter specifies the error handling tactics:

For each file being uploaded a pair of FileOperation and FileOperationResult events are invoked.

ControlReceive Event (FTPClient Component)

Fires when data is received via the control channel.

Syntax

typedef struct {
  String TextLine;
} TsbxFTPClientControlReceiveEventParams;
typedef void __fastcall (__closure *TsbxFTPClientControlReceiveEvent)(System::TObject* Sender, TsbxFTPClientControlReceiveEventParams *e);
__property TsbxFTPClientControlReceiveEvent OnControlReceive = { read=FOnControlReceive, write=FOnControlReceive };

Remarks

TextLine contains the data that was received, which would typically contain a reply to a command (e.g. 200 Command OK).

ControlSend Event (FTPClient Component)

Fires when data is about to be set via the control channel.

Syntax

typedef struct {
  String TextLine;
} TsbxFTPClientControlSendEventParams;
typedef void __fastcall (__closure *TsbxFTPClientControlSendEvent)(System::TObject* Sender, TsbxFTPClientControlSendEventParams *e);
__property TsbxFTPClientControlSendEvent OnControlSend = { read=FOnControlSend, write=FOnControlSend };

Remarks

TextLine contains the data to be sent, which would typically contain a command issued by the client (e.g. CWD dir).

Error Event (FTPClient Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TsbxFTPClientErrorEventParams;
typedef void __fastcall (__closure *TsbxFTPClientErrorEvent)(System::TObject* Sender, TsbxFTPClientErrorEventParams *e);
__property TsbxFTPClientErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The event is fired in case of exceptional conditions during message processing.

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

ExternalSign Event (FTPClient Component)

Handles remote or external signing initiated by the SignExternal method or other source.

Syntax

typedef struct {
  String OperationId;
  String HashAlgorithm;
  String Pars;
  String Data;
  String SignedData;
} TsbxFTPClientExternalSignEventParams;
typedef void __fastcall (__closure *TsbxFTPClientExternalSignEvent)(System::TObject* Sender, TsbxFTPClientExternalSignEventParams *e);
__property TsbxFTPClientExternalSignEvent OnExternalSign = { read=FOnExternalSign, write=FOnExternalSign };

Remarks

Assign a handler to this event if you need to delegate a low-level signing operation to an external, remote, or custom signing engine. Depending on the settings, the handler will receive a hashed or unhashed value to be signed.

The event handler must pass the value of Data to the signer, obtain the signature, and pass it back to the component via the SignedData parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact component being used, and may be empty. HashAlgorithm specifies the hash algorithm being used for the operation, and Pars contains algorithm-dependent parameters.

The component uses base16 (hex) encoding for the Data, SignedData, and Pars parameters. If your signing engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the signing.

A sample MD5 hash encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

A sample event handler that uses the .NET RSACryptoServiceProvider class may look like the following: signer.OnExternalSign += (s, e) => { var cert = new X509Certificate2("cert.pfx", "", X509KeyStorageFlags.Exportable); var key = (RSACryptoServiceProvider)cert.PrivateKey; var dataToSign = e.Data.FromBase16String(); var signedData = key.SignHash(dataToSign, "2.16.840.1.101.3.4.2.1"); e.SignedData = signedData.ToBase16String(); };

FileNameChangeNeeded Event (FTPClient Component)

Asks the application for a new file name.

Syntax

typedef struct {
  String FileName;
  bool Force;
} TsbxFTPClientFileNameChangeNeededEventParams;
typedef void __fastcall (__closure *TsbxFTPClientFileNameChangeNeededEvent)(System::TObject* Sender, TsbxFTPClientFileNameChangeNeededEventParams *e);
__property TsbxFTPClientFileNameChangeNeededEvent OnFileNameChangeNeeded = { read=FOnFileNameChangeNeeded, write=FOnFileNameChangeNeeded };

Remarks

The component uses this event to ask the application for a new file name in the case of a name conflict. Adjust the FileName as required to avoid the conflict, or set Force to true to go ahead with the current name (possibly overwriting an existing file).

FileOperation Event (FTPClient Component)

Marks the start of a file transfer.

Syntax

typedef struct {
  int Operation;
  String RemotePath;
  String LocalPath;
  bool Skip;
  bool Cancel;
} TsbxFTPClientFileOperationEventParams;
typedef void __fastcall (__closure *TsbxFTPClientFileOperationEvent)(System::TObject* Sender, TsbxFTPClientFileOperationEventParams *e);
__property TsbxFTPClientFileOperationEvent OnFileOperation = { read=FOnFileOperation, write=FOnFileOperation };

Remarks

The component fires this event from DownloadFiles and UploadFiles to notify the application that the transfer of the next file in the list is about to start.

Use the Skip parameter to skip this particular file, or Cancel to cancel the whole multi-file operation.

Operations:

FileOperationResult Event (FTPClient Component)

Reports the result of a file transfer operation.

Syntax

typedef struct {
  int Operation;
  String RemotePath;
  String LocalPath;
  int ErrorCode;
  String Comment;
  bool Cancel;
} TsbxFTPClientFileOperationResultEventParams;
typedef void __fastcall (__closure *TsbxFTPClientFileOperationResultEvent)(System::TObject* Sender, TsbxFTPClientFileOperationResultEventParams *e);
__property TsbxFTPClientFileOperationResultEvent OnFileOperationResult = { read=FOnFileOperationResult, write=FOnFileOperationResult };

Remarks

The component fires this event from DownloadFiles and UploadFiles to notify the application of the completion of a file operation.

ErrorCode and Comment provide the details of the operation. Use the Cancel parameter to terminate the whole multi-file operation if needed.

Operations:

ListEntry Event (FTPClient Component)

Reports a single entry from the requested directory listing.

Syntax

typedef struct {
  String FileName;
} TsbxFTPClientListEntryEventParams;
typedef void __fastcall (__closure *TsbxFTPClientListEntryEvent)(System::TObject* Sender, TsbxFTPClientListEntryEventParams *e);
__property TsbxFTPClientListEntryEvent OnListEntry = { read=FOnListEntry, write=FOnListEntry };

Remarks

FileName contains the filename of the reported entry. Read the details of the entry from CurrentListEntry property.

Notification Event (FTPClient Component)

This event notifies the application about an underlying control flow event.

Syntax

typedef struct {
  String EventID;
  String EventParam;
} TsbxFTPClientNotificationEventParams;
typedef void __fastcall (__closure *TsbxFTPClientNotificationEvent)(System::TObject* Sender, TsbxFTPClientNotificationEventParams *e);
__property TsbxFTPClientNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

This component can fire this event with the following EventID values:

Progress Event (FTPClient Component)

Reports the data transfer progress.

Syntax

typedef struct {
  __int64 Total;
  __int64 Current;
  bool Cancel;
} TsbxFTPClientProgressEventParams;
typedef void __fastcall (__closure *TsbxFTPClientProgressEvent)(System::TObject* Sender, TsbxFTPClientProgressEventParams *e);
__property TsbxFTPClientProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

This event fires periodically during a file transfer operation to report its progress.

Use the Cancel parameter to terminate the transfer if needed.

TextDataLine Event (FTPClient Component)

Reports next transferred data line.

Syntax

typedef struct {
  String TextLine;
} TsbxFTPClientTextDataLineEventParams;
typedef void __fastcall (__closure *TsbxFTPClientTextDataLineEvent)(System::TObject* Sender, TsbxFTPClientTextDataLineEventParams *e);
__property TsbxFTPClientTextDataLineEvent OnTextDataLine = { read=FOnTextDataLine, write=FOnTextDataLine };

Remarks

The component fires this event in series when transferring a file in ASCII mode to report each line being transferred.

TLSCertNeeded Event (FTPClient Component)

Fires when a remote TLS party requests a client certificate.

Syntax

typedef struct {
  String Host;
  String CANames;
} TsbxFTPClientTLSCertNeededEventParams;
typedef void __fastcall (__closure *TsbxFTPClientTLSCertNeededEvent)(System::TObject* Sender, TsbxFTPClientTLSCertNeededEventParams *e);
__property TsbxFTPClientTLSCertNeededEvent OnTLSCertNeeded = { read=FOnTLSCertNeeded, write=FOnTLSCertNeeded };

Remarks

This event fires to notify the implementation that a remote TLS server has requested a client certificate. The Host parameter identifies the host that makes a request, and the CANames parameter (optional, according to the TLS spec) advises on the accepted issuing CAs.

Use the TLSClientChain property in response to this event to provide the requested certificate. Please make sure the client certificate includes the associated private key. Note that you may set the certificates before the connection without waiting for this event to fire.

This event is preceded by the TLSHandshake event for the given host and, if the certificate was accepted, succeeded by the TLSEstablished event.

TLSCertValidate Event (FTPClient Component)

This event is fired upon receipt of the TLS server's certificate, allowing the user to control its acceptance.

Syntax

typedef struct {
  String ServerHost;
  String ServerIP;
  bool Accept;
} TsbxFTPClientTLSCertValidateEventParams;
typedef void __fastcall (__closure *TsbxFTPClientTLSCertValidateEvent)(System::TObject* Sender, TsbxFTPClientTLSCertValidateEventParams *e);
__property TsbxFTPClientTLSCertValidateEvent OnTLSCertValidate = { read=FOnTLSCertValidate, write=FOnTLSCertValidate };

Remarks

This event is fired during a TLS handshake. Use the TLSServerChain property to access the certificate chain. In general, components may contact a number of TLS endpoints during their work, depending on their configuration.

Accept is assigned in accordance with the outcome of the internal validation check performed by the component, and can be adjusted if needed.

TLSEstablished Event (FTPClient Component)

Fires when a TLS handshake with Host successfully completes.

Syntax

typedef struct {
  String Host;
  String Version;
  String Ciphersuite;
  DynamicArray ConnectionId;
  bool Abort;
} TsbxFTPClientTLSEstablishedEventParams;
typedef void __fastcall (__closure *TsbxFTPClientTLSEstablishedEvent)(System::TObject* Sender, TsbxFTPClientTLSEstablishedEventParams *e);
__property TsbxFTPClientTLSEstablishedEvent OnTLSEstablished = { read=FOnTLSEstablished, write=FOnTLSEstablished };

Remarks

The component uses this event to notify the application about a successful completion of a TLS handshake.

The Version, Ciphersuite, and ConnectionId parameters indicate the security parameters of the new connection. Use the Abort parameter if you need to terminate the connection at this stage.

TLSHandshake Event (FTPClient Component)

Fires when a new TLS handshake is initiated, before the handshake commences.

Syntax

typedef struct {
  String Host;
  bool Abort;
} TsbxFTPClientTLSHandshakeEventParams;
typedef void __fastcall (__closure *TsbxFTPClientTLSHandshakeEvent)(System::TObject* Sender, TsbxFTPClientTLSHandshakeEventParams *e);
__property TsbxFTPClientTLSHandshakeEvent OnTLSHandshake = { read=FOnTLSHandshake, write=FOnTLSHandshake };

Remarks

The component uses this event to notify the application about the start of a new TLS handshake to Host. If the handshake is successful, this event will be followed by the TLSEstablished event. If the server chooses to request a client certificate, the TLSCertNeeded event will also be fired.

TLSPSK Event (FTPClient Component)

Notifies the application about the PSK key exchange.

Syntax

typedef struct {
  String Host;
  String Hint;
} TsbxFTPClientTLSPSKEventParams;
typedef void __fastcall (__closure *TsbxFTPClientTLSPSKEvent)(System::TObject* Sender, TsbxFTPClientTLSPSKEventParams *e);
__property TsbxFTPClientTLSPSKEvent OnTLSPSK = { read=FOnTLSPSK, write=FOnTLSPSK };

Remarks

The component fires this event to notify the application about the beginning of TLS-PSK key exchange with Host. The Hint parameter may be used by the server to identify the key or service to use. Use the PreSharedKey field of TLSSettings to provide the pre-shared key to the component.

TLSShutdown Event (FTPClient Component)

Reports the graceful closure of a TLS connection.

Syntax

typedef struct {
  String Host;
} TsbxFTPClientTLSShutdownEventParams;
typedef void __fastcall (__closure *TsbxFTPClientTLSShutdownEvent)(System::TObject* Sender, TsbxFTPClientTLSShutdownEventParams *e);
__property TsbxFTPClientTLSShutdownEvent OnTLSShutdown = { read=FOnTLSShutdown, write=FOnTLSShutdown };

Remarks

This event notifies the application about the closure of an earlier established TLS connection. Note that only graceful connection closures are reported.

Config Settings (FTPClient 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.

FTPClient Config Settings

Base Config Settings

Trappable Errors (FTPClient Component)

FTPClient Errors