OFTPClient Control

Properties   Methods   Events   Config Settings   Errors  

The OFTPClient control implements the Odette File Transfer Protocol.

Syntax

OFTPClient

Remarks

The OFTPClient component may be used to send and receive OFTP files to and from an OFTP server.

Receiving Files

The OFTPClient ReceiveFiles function requires certain server properties be set. You must set the RemoteHost property to the remote location of the desired OFTP server. You may also set a RemotePort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.

The control will connect to the OFTP server and download all files in the server's outgoing queue, and write these files to the directory specified by DownloadDirectory. The control creates a default location on the local machine based on the values of the DownloadDirectory and the Virtual Filename as received from the server. If a different location is preferred, you may set the LocalFile parameter of the StartTransfer event.

Sending Files

The OFTPClient SendFile function requires the same server and authentication properties to be set as the ReceiveFiles function.

The control will connect to the OFTP server and upload the file contained by the LocalFile parameter. It uses the name specified by VirtualFileName when sending to the server. If this is not specified, the filename of the local file is parsed and used as the virtual filename.

Property List

---

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

Method List

---

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

Event List

---

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

---

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

CertEncoded Property (OFTPClient Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpclientcontrol.CertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertEncodedB.

This property is not available at design time.

Data Type

Binary String

CertStore Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.CertStore[=string]

Default Value

"MY"

Remarks

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

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertStoreB.

Data Type

Binary String

CertStorePassword Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.CertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

CertStoreType Property (OFTPClient Control)

This is the type of certificate store for this certificate.

Syntax

oftpclientcontrol.CertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

CertSubject Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.CertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

ClientPassword Property (OFTPClient Control)

The client's password.

Syntax

oftpclientcontrol.ClientPassword[=string]

Default Value

""

Remarks

The password assigned to the client in the bilateral agreement. This property must be a string of no more than 8 characters long.

Data Type

String

ClientSFIDCode Property (OFTPClient Control)

Client's SFID code.

Syntax

oftpclientcontrol.ClientSFIDCode[=string]

Default Value

""

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

Data Type

String

ClientSSIDCode Property (OFTPClient Control)

The client's SSID code.

Syntax

oftpclientcontrol.ClientSSIDCode[=string]

Default Value

""

Remarks

The identification code of the client. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

Data Type

String

Compress Property (OFTPClient Control)

Whether or not to compress the outgoing file.

Syntax

oftpclientcontrol.Compress[=boolean]

Default Value

False

Remarks

When sending a file to the trading partner, set this to true for the control to compress the file before sending. The file will first be compressed to a temporary file before being sent.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by Version.

This property is not available at design time.

Data Type

Boolean

Connected Property (OFTPClient Control)

Shows whether the control is connected.

Syntax

oftpclientcontrol.Connected[=boolean]

Default Value

False

Remarks

Use this property to determine whether the control is connected to the remote host or not.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

This property is not available at design time.

Data Type

Boolean

DownloadDirectory Property (OFTPClient Control)

Download directory.

Syntax

oftpclientcontrol.DownloadDirectory[=string]

Default Value

"./"

Remarks

This property contains the location on disk of the folder the control will write received files to. The default for this property is "./", which is the current working directory.

Note: If this property is set to empty string data will not be written to disk and instead will be available through the Transfer event.

Data Type

String

EncryptionAlgorithm Property (OFTPClient Control)

The encryption algorithm.

Syntax

oftpclientcontrol.EncryptionAlgorithm[=integer]

Possible Values

encra3DES(0), 
encraAES(1)

Default Value

0

Remarks

In order to use encryption, you must set the VirtualFileSecurityLevel property. The supported algorithms for encryption are:

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

FirewallType Property (OFTPClient Control)

This property determines the type of firewall to connect through.

Syntax

oftpclientcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.FirewallHost[=string]

Default Value

""

Remarks

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

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

Data Type

String

FirewallPassword Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.FirewallPassword[=string]

Default Value

""

Remarks

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

Data Type

String

FirewallPort Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.FirewallPort[=integer]

Default Value

0

Remarks

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

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

Data Type

Integer

FirewallUser Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.FirewallUser[=string]

Default Value

""

Remarks

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

Data Type

String

LocalHost Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.LocalHost[=string]

Default Value

""

Remarks

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

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

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

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

Data Type

String

MaxRecordSize Property (OFTPClient Control)

The maximum length of a given record.

Syntax

oftpclientcontrol.MaxRecordSize[=integer]

Default Value

0

Remarks

This value determines the maximum length for a record in the outgoing virtual file. When VirtualFileFormat has been set to ffUnstructured or ffText, this value must be zero. When ffFixed or ffVariable, this must be set to a value greater than 0, containing the maximum line length of the outgoing file.

Data Type

Integer

Overwrite Property (OFTPClient Control)

Whether or not the control should overwrite files during transfer.

Syntax

oftpclientcontrol.Overwrite[=boolean]

Default Value

False

Remarks

This property is a value indicating whether or not the control should overwrite downloaded files. If Overwrite is false, an error will be thrown whenever the local file exists before a receive operation.

Data Type

Boolean

RecipientCertEncoded Property (OFTPClient Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpclientcontrol.RecipientCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertEncodedB.

This property is not available at design time.

Data Type

Binary String

RecipientCertStore Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.RecipientCertStore[=string]

Default Value

"MY"

Remarks

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

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertStoreB.

This property is not available at design time.

Data Type

Binary String

RecipientCertStorePassword Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.RecipientCertStorePassword[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

RecipientCertStoreType Property (OFTPClient Control)

This is the type of certificate store for this certificate.

Syntax

oftpclientcontrol.RecipientCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

This property is not available at design time.

Data Type

Integer

RecipientCertSubject Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.RecipientCertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

This property is not available at design time.

Data Type

String

RemoteHost Property (OFTPClient Control)

The domain name or IP address of the OFTP server.

Syntax

oftpclientcontrol.RemoteHost[=string]

Default Value

""

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the OFTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If the RemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.

If the control is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

RemotePort Property (OFTPClient Control)

The port for the OFTP service (default is 3305).

Syntax

oftpclientcontrol.RemotePort[=integer]

Default Value

3305

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

When UseSSL is set to True this property will be set to 6619.

This property is not available at design time.

Data Type

Integer

SecureAuthentication Property (OFTPClient Control)

Whether or not the control should perform secure Odette authentication.

Syntax

oftpclientcontrol.SecureAuthentication[=boolean]

Default Value

False

Remarks

If true, the control will perform secure authentication when connecting to the server. The secure authentication consists of encrypting and decrypting data sent to and from the server, and verifying that this occurred successfully. Secure authentication may be performed in plaintext or SSL mode.

Both Certificate and RecipientCert properties must be populated when this property is set to true.

This is only valid for version 2.0 of the protocol.

This property is not available at design time.

Data Type

Boolean

ServerPassword Property (OFTPClient Control)

The server's password.

Syntax

oftpclientcontrol.ServerPassword[=string]

Default Value

""

Remarks

The password assigned to the server in the bilateral agreement. This property must be a string of no more than 8 characters long.

Data Type

String

ServerSFIDCode Property (OFTPClient Control)

Server's SFID code.

Syntax

oftpclientcontrol.ServerSFIDCode[=string]

Default Value

""

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

Data Type

String

ServerSSIDCode Property (OFTPClient Control)

The server's SSID code.

Syntax

oftpclientcontrol.ServerSSIDCode[=string]

Default Value

""

Remarks

The identification code of the server. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

Data Type

String

SignedReceipt Property (OFTPClient Control)

Whether or not to require signed receipts.

Syntax

oftpclientcontrol.SignedReceipt[=boolean]

Default Value

False

Remarks

When sending a file to a trading partner, set this to true if the file receipt should be signed by the server. When this receipt is received by the control, it will be verified during processing.

NOTE: If the server does not attach the public certificate in the signed message, the server's public key must be specified in the RecipientCert property in order for verification to succeed.

This property is not available at design time.

Data Type

Boolean

SSLAcceptServerCertEncoded Property (OFTPClient Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpclientcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (OFTPClient Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpclientcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (OFTPClient Control)

This is the type of certificate store for this certificate.

Syntax

oftpclientcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

Timeout Property (OFTPClient Control)

A timeout for the control.

Syntax

oftpclientcontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the control will wait for the operation to complete before returning control. The control will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TrustedCertCount Property (OFTPClient Control)

The number of records in the TrustedCert arrays.

Syntax

oftpclientcontrol.TrustedCertCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertEncoded
• TrustedCertStore
• TrustedCertStorePassword
• TrustedCertStoreType
• TrustedCertSubject

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

This property is not available at design time.

Data Type

Integer

TrustedCertEncoded Property (OFTPClient Control)

This is the certificate (PEM/Base64 encoded).

Syntax

oftpclientcontrol.TrustedCertEncoded(TrustedCertIndex)[=string]

Default Value

""

Remarks

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

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .TrustedCertEncodedB.

This property is not available at design time.

Data Type

Binary String

TrustedCertStore Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.TrustedCertStore(TrustedCertIndex)[=string]

Default Value

"MY"

Remarks

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

The TrustedCertStoreType property denotes the type of the certificate store specified by TrustedCertStore. If the store is password protected, specify the password in TrustedCertStorePassword.

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

Designations of certificate stores are platform dependent.

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

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

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

To read or write binary data to the property, a Variant (Byte Array) version is provided in .TrustedCertStoreB.

This property is not available at design time.

Data Type

Binary String

TrustedCertStorePassword Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.TrustedCertStorePassword(TrustedCertIndex)[=string]

Default Value

""

Remarks

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

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

String

TrustedCertStoreType Property (OFTPClient Control)

This is the type of certificate store for this certificate.

Syntax

oftpclientcontrol.TrustedCertStoreType(TrustedCertIndex)[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

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

Integer

TrustedCertSubject Property (OFTPClient Control)

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

Syntax

oftpclientcontrol.TrustedCertSubject(TrustedCertIndex)[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

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

String

UseSSL Property (OFTPClient Control)

Use SSL to access the RemoteHost .

Syntax

oftpclientcontrol.UseSSL[=boolean]

Default Value

False

Remarks

Use this property to determine whether the control uses SSL to connect with the RemoteHost.

This property is only valid when using version 2.0 of the protocol.

Note: Setting this property to True will set RemotePort to 6619.

This property is not available at design time.

Data Type

Boolean

Version Property (OFTPClient Control)

Which version of the OFTP protocol the control is using.

Syntax

oftpclientcontrol.Version[=integer]

Possible Values

oftpVer12(0), 
oftpVer13(1), 
oftpVer14(2), 
oftpVer20(3)

Default Value

3

Remarks

This property specifies which version of the OFTP protocol to use. Possible values are:

The default value is oftpVer20 (Version 2.0).

Note: Version 2.0 (oftpVer20) of the protocol must be used when using security functions. The following properties are only applicable when using Version 2.0:

• UseSSL
• SecureAuthentication
• VirtualFileSecurityLevel
• Compress

Data Type

Integer

VirtualFileDate Property (OFTPClient Control)

The date/time stamp for the virtual file.

Syntax

oftpclientcontrol.VirtualFileDate[=string]

Default Value

""

Remarks

Set this to the date/time stamp for the virtual file before sending. If this is not set when sending a file, the current date/time will be used. This property will accept various date formats, but will return the following format only: "MM/dd/yyyy HH:mm:ss".

Supported date formats:

• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• d MMM yy HH:mm:ss zzz
• d MMM yyyy HH:mm:ss zzz
• dd-MMM-yyyy HH:mm:ss
• ddd, d MMM yy HH:mm:ss zz
• ddd, d MMM yyyy HH:mm:ss zz
• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• ddd, d MMM yy HH:mm:ss z
• ddd, d MMM yyyy HH:mm:ss z
• ddd, dd MMM yyyy HH:mm:ss 'GMT'
• dddd, MMMM dd, yyyy h:mm:ss tt
• dddd, MMMM dd yyyy h:mm tt
• yyMMddHHmmssZ
• yyyyMMddHHmmssZ
• yyMMddHHmmsszzzz
• yyyyMMddHHmmsszzzz
• yyyyMMddHHmmssffff
• MM/dd/yyyy HH:mm:ss

Data Type

String

VirtualFileFormat Property (OFTPClient Control)

The structure of the outgoing file.

Syntax

oftpclientcontrol.VirtualFileFormat[=integer]

Possible Values

ffUnstructured(0), 
ffText(1), 
ffFixed(2), 
ffVariable(3)

Default Value

0

Remarks

The following values are valid file formats for outgoing virtual files:

Note: When either VirtualFileSecurityLevel has been set to a value other than slNone or Compress has been set to true, all files become ffUnstructured except ffVariable files.

This property is not available at design time.

Data Type

Integer

VirtualFileSecurityLevel Property (OFTPClient Control)

The level of security for the file.

Syntax

oftpclientcontrol.VirtualFileSecurityLevel[=integer]

Possible Values

slNone(0), 
slEncrypted(1), 
slSigned(2), 
slEncryptedAndSigned(3)

Default Value

0

Remarks

When sending files, set this value to the level of security for the next virtual file to send. After receiving a file, this will be set to the level of security of the last file received.

When encrypting a file, RecipientCert must be set, and when signing a file, the Certificate must be set.

The file will be processed to a temporary file before being sent.

This is only valid for version 2.0 of the protocol.

This property is not available at design time.

Data Type

Integer

ChangeDirection Method (OFTPClient Control)

Sends a Change Direction (CD) command.

Syntax

oftpclientcontrol.ChangeDirection 

Remarks

This method sends a Change Direction (CD) command to the remote host when called. In normal operation this should not be used. This should only be used if a condition arises where you must manually change the speaker when communicating with the remote host.

Config Method (OFTPClient Control)

Sets or retrieves a configuration setting.

Syntax

oftpclientcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 (OFTPClient Control)

This method connects to the FTP server without logging in.

Syntax

oftpclientcontrol.Connect 

Remarks

This method establishes a connection with the RemoteHost but does not log in. In most cases, it is recommended to use the Logon method, which will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, confirming that a host is available by first creating the connection.

Disconnect Method (OFTPClient Control)

This method disconnects from the server without first logging off.

Syntax

oftpclientcontrol.Disconnect 

Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the Logoff method should be used to log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

DoEvents Method (OFTPClient Control)

Processes events from the internal message queue.

Syntax

oftpclientcontrol.DoEvents 

Remarks

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

ExchangeCertificate Method (OFTPClient Control)

Exchange a certificate with the remote host.

Syntax

oftpclientcontrol.ExchangeCertificate CertificateStore, CertificateExchangeType

Remarks

If the remote host supports the certificate exchange feature of OFTP 2.0 this method may be used to send and/or request certificates.

The CertificateStore parameter specifies the location of the certificate to be exchanged. In most cases this will be the path to a .cer file on disk. If the certificate is in another format or is installed to the Windows certificate store please see ExchangeCertStoreType and ExchangeCertSubject for more information.

The CertificateExchangeType parameter determines the type of request. Possible values are:

When the remote host sends a certificate to the control the received certificate will be provided through the CertificateReceived event.

ImportTrustedCerts Method (OFTPClient Control)

Imports a list of trusted CA certificates.

Syntax

oftpclientcontrol.ImportTrustedCerts 

Remarks

When ImportTrustedCerts is called the control will import the CA certificates from the source specified by TrustedCertsData into the TrustedCerts collection.

The control will then validate the trust of certificates when they are loaded.

If trusted CA certificates are not imported no validation will occur (default).

See also FailOnUntrustedCert.

Interrupt Method (OFTPClient Control)

This method interrupts the current action.

Syntax

oftpclientcontrol.Interrupt 

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the control will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

Logoff Method (OFTPClient Control)

Logoff from the OFTP server.

Syntax

oftpclientcontrol.Logoff 

Remarks

Logoff from the OFTP server. If that fails, the connection is terminated by the local host.

Logon Method (OFTPClient Control)

Logon to the OFTP RemoteHost using the current client credentials.

Syntax

oftpclientcontrol.Logon 

Remarks

Logon to the OFTP server using the current ClientSSIDCode, ClientSFIDCode, and ClientPassword. The component will also check the corresponding server credentials, ServerSSIDCode, ServerSFIDCode, and ServerPassword.

ReceiveFiles Method (OFTPClient Control)

Receive any files queued to be sent from the server.

Syntax

oftpclientcontrol.ReceiveFiles 

Remarks

This method connects to the server, and receives any files the server has in its outgoing queue to this particular partner. The files are downloaded to the directory specified by the DownloadDirectory property.

Reset Method (OFTPClient Control)

Resets the state of the control.

Syntax

oftpclientcontrol.Reset 

Remarks

Reset resets the state of the control. All properties will be set to their default values.

SendEndResponse Method (OFTPClient Control)

Sends an EERP/NERP asynchronously.

Syntax

oftpclientcontrol.SendEndResponse VirtualFileName, VirtualFileDate, Destination, Originator, Creator, ReasonCode, ReasonText, FileHash, Signature

Remarks

This method sends an EERP/NERP. By default the control will automatically respond with an EERP/NERP when receiving a file. To respond asynchronously instead this method may be used.

To respond asynchronously first set the SendEndResponse parameter of the EndTransfer event to False. This instructs the control to not send a response automatically. Within the EndTransfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

Destination should be set to the SFID of the remote host.

Originator should be set to the SFID of the local system. In the case that the control is being used as part of a gateway process to forward traffic to another OFTP host this may be set to the SFID of that host instead.

Creator should be set to the SFID of the local system.

Signature is only applicable if the application is acting as a routing application. In all other cases this should be set to empty string. In the case where the application is acting as a routing application the end response is being forwarded to another entity for processing. The Signature should be set to the value received in the EndResponse event (if populated).

ReasonCode and ReasonText are used to specify error information. If ReasonCode is set to 0 the control will send an EERP. If ReasonCode is set to any non-zero value the control will send a NERP. Common values are:

SendFile Method (OFTPClient Control)

Send the specified file to the server.

Syntax

oftpclientcontrol.SendFile LocalFile, VirtualFileName

Remarks

This method connects to the server, and uploads the specified file to the server. The LocalFile parameter contains the path and name of the file to send to the server. The VirtualFileName parameter contains the virtual file name of the file being sent. If this parameter is left as an empty string, the component will use the filename contained in the LocalFile parameter by default.

Note: When SetUploadStream has been called with a valid input stream, the data will be uploaded from there instead of the LocalFile.

ValidateCert Method (OFTPClient Control)

Validates the certificate with private key.

Syntax

oftpclientcontrol.ValidateCert 

Remarks

This method optionally validates the certificate specified by Certificate. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the control:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

ValidateRecipientCert Method (OFTPClient Control)

Validates the recipient certificate.

Syntax

oftpclientcontrol.ValidateRecipientCert 

Remarks

This method optionally validates the certificate specified by RecipientCert. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the control:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

AcceptFile Event (OFTPClient Control)

Fired when the client receives a file.

Syntax

Sub oftpclientcontrol_AcceptFile(VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, Accept As Boolean, Filename As String, Overwrite As Boolean, ErrorCode As Integer, ErrorDescription As String)

Remarks

This event controls the behavior when the client receives a file.

VirtualFileName holds the name of the file being received.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination identifies the receiver (SFID) code in the send file request. If the file was intended for this server this will match the value in ServerSFIDCode

Originator identifies the sender (SFID) code in the send file request.

Accept is true by default, and must be set to False in order to reject the file.

Filename will be populated with the full path and filename that will be written. It may be changed within this event to specify a new location. The Filename is determined by combining the path specified in OFTPConnectionDownloadDirectory and the name received from the client.

Overwrite is false by default, but may be set to true to overwrite existing files on disk.

ErrorCode controls the error returned to the client when Accept is set to False. If this is not set the control will use a value of 99 to indicate a general error.

ErrorDescription may also be set to include an error message. If this is not set the control will automatically include an error message based on the ErrorCode specified. Common error codes and their corresponding error messages are listed below.

CertificateReceived Event (OFTPClient Control)

Fired when a certificate is received from the remote host.

Syntax

Sub oftpclientcontrol_CertificateReceived(CertificateFileName As String, CertificateExchangeType As Integer)

Remarks

This event provides information about the certificate file that was sent by the remote host.

When the remote host sends a certificate using the Certificate Exchange feature of OFTP 2.0, this event provides information about it. The certificate file will be written to the DownloadDirectory. After the file is written to DownloadDirectory this event will fire.

The CertificateFilemame parameter holds the filename of the received certificate.

The CertificateExchangeType parameter identifies the type of request associated with the certificate. Possible values are:

EndResponse Event (OFTPClient Control)

Fired every time an end response is received from the server.

Syntax

Sub oftpclientcontrol_EndResponse(VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, Creator As String, ReasonCode As Integer, ReasonText As String, FileHash As String, Signature As String, Direction As Integer)

Remarks

This event contains information received from an either an End-To-End Response or a Negative End Response received from the server.

An End-To-End Response will not contain values for the ReasonCode, ReasonText, or Creator parameters.

VirtualFileName specifies the name of the file.

VirtualFileDate holds the VirtualFileDate value in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination is the SFID of the destination system (this control).

Originator identifies the system that originated the end response. This is typically the same as Creator and holds the remote system's SFID.

Creator is the SFID of the remote system.

Direction specifies whether the end response is being received or sent. Possible values are:

By default the control will only fire this event for received end responses. To configure the control to fire the event for both send and received end responses set FireEndResponseOnSend to True.

FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the EndTransfer event when initially sending the file.

Signature is only applicable when the OFTP version is 2.0 and the application is acting as a routing application where the end response will be forwarded on to another entity. In this case Signature will be populated if the end response is signed. This should be stored and supplied when forwarding the response with the SendEndResponse method.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

EndTransfer Event (OFTPClient Control)

Fired when a file finishes transferring.

Syntax

Sub oftpclientcontrol_EndTransfer(Direction As Integer, LocalFile As String, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, ReasonCode As Integer, ReasonText As String, FileSize As Long64, FileHash As String, SendEndResponse As Boolean)

Remarks

The EndTransfer event is fired when a file is sent or received by the control.

The FileSize parameter gives the size of the file that was sent or received.

The Direction parameter shows whether the client or the server is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

SendEndResponse indicates whether the EERP/NERP for this request should be sent synchronously or asynchronously. When this parameter is True (default) the control will automatically respond with an EERP/NERP synchronously. To respond asynchronously set this parameter to False. You may then use the SendEndResponse method to send the response at a later time. See SendEndResponse for more details. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

FileHash holds the hash of the file being transmitted. This is only applicable when the OFTP version is 2.0 and the sender requested a signed receipt. When receiving files this value should be saved if you wish to respond asynchronously using SendEndResponse. See SendEndResponse for more details.

LocalFile holds the full path to the file that will be written.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

Error Event (OFTPClient Control)

Fired when information is available about errors during data delivery.

Syntax

Sub oftpclientcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

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

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

Log Event (OFTPClient Control)

Fires once for each log message.

Syntax

Sub oftpclientcontrol_Log(LogLevel As Integer, Message As String, LogType As String)

Remarks

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

LogLevel indicates the level of message. Possible values are:

Message is the log entry.

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

• "Info"
• "OFTP"

PITrail Event (OFTPClient Control)

Fired when any protocol level communication occurs.

Syntax

Sub oftpclientcontrol_PITrail(Direction As Integer, Data As String, CommandId As Integer, CommandDescription As String)

Remarks

This event provides information about the protocol level communication between the client and server.

The Direction parameter specifies who sent the command.

The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.

The Data parameter contains the raw OFTP packet.

SSLServerAuthentication Event (OFTPClient Control)

Fired after the server presents its certificate to the client.

Syntax

Sub oftpclientcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

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

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

SSLStatus Event (OFTPClient Control)

Fired when secure connection progress messages are available.

Syntax

Sub oftpclientcontrol_SSLStatus(Message As String)

Remarks

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

StartTransfer Event (OFTPClient Control)

Fired when a document starts transferring.

Syntax

Sub oftpclientcontrol_StartTransfer(Direction As Integer, LocalFile As String, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String)

Remarks

This event fires when a file transfer begins.

Direction specifies if the client or server sent the file.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

Transfer Event (OFTPClient Control)

Fired while a document transfers (delivers document).

Syntax

Sub oftpclientcontrol_Transfer(Direction As Integer, LocalFile As String, VirtualFileName As String, VirtualFileDate As String, Destination As String, Originator As String, BytesTransferred As Long64, Text As String)

Remarks

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

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.

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

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

Config Settings (OFTPClient Control)

The control 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 control, access to these internal properties is provided through the Config method.

OFTPClient Config Settings

Base Config Settings

Trappable Errors (OFTPClient Control)

OFTPClient Errors

	20672    OFTP protocol error.
	20673    Server supplied an invalid SSID code.
	20674    Server supplied an invalid SFID code.
	20675    Server supplied an invalid password.
	20676    Server returned an invalid client SSID code.
	20677    Server returned an invalid client SFID code.
	20678    Server returned an invalid client password.
	20679    "Error building packet to send."
	20680    Error reading files specified.
	20681    Invalid date timestamp.
	20682    Local file exists and overwrite is set to false.
	20683    Invalid hash value.
	20684    Invalid signature.
	20685    Cryptographic operation failed.
	20686    No encryption certificate was specified.
	20687    No signing certificate was specified.
	20688    Send failed. Check the description for more details.
	20689    The requested feature is only supported in OFTP Version 2.0. Check the description for more details.
	20690    A required certificate was not provided. The error descriptions indicates which property must be set.
	20691    Invalid Certificate.
	20692    Failed to import trusted certificates.

TCPClient Errors

	20101    You cannot change the RemotePort at this time. A connection is in progress.
	20102    You cannot change the RemoteHost (Server) at this time. A connection is in progress.
	20103    The RemoteHost address is invalid (0.0.0.0).
	20105    Already connected. If you want to reconnect, close the current connection first.
	20107    You cannot change the LocalPort at this time. A connection is in progress.
	20108    You cannot change the LocalHost at this time. A connection is in progress.
	20113    You cannot change MaxLineLength at this time. A connection is in progress.
	20117    RemotePort cannot be zero. Please specify a valid service port number.
	20118    You cannot change the UseConnection option while the control is active.
	20136    Operation would block.
	20202    Timeout.
	20212    Action impossible in control's present state.
	20213    Action impossible while not connected.
	20214    Action impossible while listening.
	20302    Timeout.
	20303    Could not open file.
	20435    Unable to convert string to selected CodePage.
	21106    Already connecting. If you want to reconnect, close the current connection first.
	21118    You need to connect first.
	21120    You cannot change the LocalHost at this time. A connection is in progress.
	21121    Connection dropped by remote host.

TCP/IP Errors

	25005    [10004] Interrupted system call.
	25010    [10009] Bad file number.
	25014    [10013] Access denied.
	25015    [10014] Bad address.
	25023    [10022] Invalid argument.
	25025    [10024] Too many open files.
	25036    [10035] Operation would block.
	25037    [10036] Operation now in progress.
	25038    [10037] Operation already in progress.
	25039    [10038] Socket operation on non-socket.
	25040    [10039] Destination address required.
	25041    [10040] Message too long.
	25042    [10041] Protocol wrong type for socket.
	25043    [10042] Bad protocol option.
	25044    [10043] Protocol not supported.
	25045    [10044] Socket type not supported.
	25046    [10045] Operation not supported on socket.
	25047    [10046] Protocol family not supported.
	25048    [10047] Address family not supported by protocol family.
	25049    [10048] Address already in use.
	25050    [10049] Can't assign requested address.
	25051    [10050] Network is down.
	25052    [10051] Network is unreachable.
	25053    [10052] Net dropped connection or reset.
	25054    [10053] Software caused connection abort.
	25055    [10054] Connection reset by peer.
	25056    [10055] No buffer space available.
	25057    [10056] Socket is already connected.
	25058    [10057] Socket is not connected.
	25059    [10058] Can't send after socket shutdown.
	25060    [10059] Too many references, can't splice.
	25061    [10060] Connection timed out.
	25062    [10061] Connection refused.
	25063    [10062] Too many levels of symbolic links.
	25064    [10063] File name too long.
	25065    [10064] Host is down.
	25066    [10065] No route to host.
	25067    [10066] Directory not empty
	25068    [10067] Too many processes.
	25069    [10068] Too many users.
	25070    [10069] Disc Quota Exceeded.
	25071    [10070] Stale NFS file handle.
	25072    [10071] Too many levels of remote in path.
	25092    [10091] Network subsystem is unavailable.
	25093    [10092] WINSOCK DLL Version out of range.
	25094    [10093] Winsock not loaded yet.
	26002    [11001] Host not found.
	26003    [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
	26004    [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
	26005    [11004] Valid name, no data record (check DNS setup).