OFTPClient Component

Properties   Methods   Events   Config Settings   Errors  

The OFTPClient component implements the Odette File Transfer Protocol.

Syntax

nsoftware.IPWorksEDI.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 component 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 component 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 component 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 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.

Certificate Property (OFTPClient Component)

The current selected certificate.

Syntax

• C#
• VB.NET

public Certificate Certificate { get; set; }

Public Property Certificate As Certificate

Remarks

This property is populated when a specified certificate is found or loaded by the component. Certificate is used for specifying private keys. Set this property to a valid Certificate object to perform different operations such as session authentication, signing a file or receipt, or decryption. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the Store and Subject fields.

ClientPassword Property (OFTPClient Component)

The client's password.

Syntax

• C#
• VB.NET

public string ClientPassword { get; set; }

Public Property ClientPassword As 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.

ClientSFIDCode Property (OFTPClient Component)

Client's SFID code.

Syntax

• C#
• VB.NET

public string ClientSFIDCode { get; set; }

Public Property ClientSFIDCode As 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.

ClientSSIDCode Property (OFTPClient Component)

The client's SSID code.

Syntax

• C#
• VB.NET

public string ClientSSIDCode { get; set; }

Public Property ClientSSIDCode As 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:

Compress Property (OFTPClient Component)

Whether or not to compress the outgoing file.

Syntax

• C#
• VB.NET

public bool Compress { get; set; }

Public Property Compress As Boolean

Default Value

False

Remarks

When sending a file to the trading partner, set this to true for the component 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.

Connected Property (OFTPClient Component)

Shows whether the component is connected.

Syntax

• C#
• VB.NET

public bool Connected { get; }

Public ReadOnly Property Connected As Boolean

Default Value

False

Remarks

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

Use the Connect and Disconnect methods to manage the connection.

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

DownloadDirectory Property (OFTPClient Component)

Download directory.

Syntax

• C#
• VB.NET

public string DownloadDirectory { get; set; }

Public Property DownloadDirectory As String

Default Value

"./"

Remarks

This property contains the location on disk of the folder the component 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.

EncryptionAlgorithm Property (OFTPClient Component)

The encryption algorithm.

Syntax

• C#
• VB.NET

public OFTPClientEncryptionAlgorithms EncryptionAlgorithm { get; set; }

enum OFTPClientEncryptionAlgorithms {
  encra3DES,
  encraAES
}

Public Property EncryptionAlgorithm As OftpclientEncryptionAlgorithms

Enum OFTPClientEncryptionAlgorithms
  encra3DES
  encraAES
End Enum

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.

Firewall Property (OFTPClient Component)

A set of properties related to firewall access.

Syntax

• C#
• VB.NET

public Firewall Firewall { get; set; }

Public Property Firewall As Firewall

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the component will attempt to connect.

LocalHost Property (OFTPClient Component)

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

Syntax

• C#
• VB.NET

public string LocalHost { get; set; }

Public Property LocalHost As String

Default Value

""

Remarks

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the component initiate connections (or accept in the case of server components) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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

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

MaxRecordSize Property (OFTPClient Component)

The maximum length of a given record.

Syntax

• C#
• VB.NET

public int MaxRecordSize { get; set; }

Public Property MaxRecordSize As 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.

Overwrite Property (OFTPClient Component)

Whether or not the component should overwrite files during transfer.

Syntax

• C#
• VB.NET

public bool Overwrite { get; set; }

Public Property Overwrite As Boolean

Default Value

False

Remarks

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

RecipientCert Property (OFTPClient Component)

The recipient certificate of the message.

Syntax

• C#
• VB.NET

public Certificate RecipientCert { get; set; }

Public Property RecipientCert As Certificate

Remarks

This property specifies the certificate to use when verifying signed files and receipts as well as encrypting files to be sent. This property must be set when SecureAuthentication has been set to true, sending a file and VirtualFileSecurityLevel has been set to slEncrypted or slEncryptedAndSigned, SignedReceipt has been set to true, or a signed file is being received and the server has not included the certificate in the signature.

The RecipientCert property must be filled out with a valid public key Certificate type object. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the Store and Subject fields.

This property is not available at design time.

RemoteHost Property (OFTPClient Component)

The domain name or IP address of the OFTP server.

Syntax

• C#
• VB.NET

public string RemoteHost { get; set; }

Public Property RemoteHost As 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 component 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.

RemotePort Property (OFTPClient Component)

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

Syntax

• C#
• VB.NET

public int RemotePort { get; set; }

Public Property RemotePort As 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.

SecureAuthentication Property (OFTPClient Component)

Whether or not the component should perform secure Odette authentication.

Syntax

• C#
• VB.NET

public bool SecureAuthentication { get; set; }

Public Property SecureAuthentication As Boolean

Default Value

False

Remarks

If true, the component 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.

ServerPassword Property (OFTPClient Component)

The server's password.

Syntax

• C#
• VB.NET

public string ServerPassword { get; set; }

Public Property ServerPassword As 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.

ServerSFIDCode Property (OFTPClient Component)

Server's SFID code.

Syntax

• C#
• VB.NET

public string ServerSFIDCode { get; set; }

Public Property ServerSFIDCode As 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.

ServerSSIDCode Property (OFTPClient Component)

The server's SSID code.

Syntax

• C#
• VB.NET

public string ServerSSIDCode { get; set; }

Public Property ServerSSIDCode As 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:

SignedReceipt Property (OFTPClient Component)

Whether or not to require signed receipts.

Syntax

• C#
• VB.NET

public bool SignedReceipt { get; set; }

Public Property SignedReceipt As 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 component, 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.

SSLAcceptServerCert Property (OFTPClient Component)

Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C#
• VB.NET

public Certificate SSLAcceptServerCert { get; set; }

Public Property SSLAcceptServerCert As Certificate

Remarks

If it finds any issues with the certificate presented by the server, the component will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

SSLCert Property (OFTPClient Component)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

Remarks

This property includes the digital certificate that the component will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Timeout Property (OFTPClient Component)

This property includes the timeout for the component.

Syntax

• C#
• VB.NET

public int Timeout { get; set; }

Public Property Timeout As Integer

Default Value

60

Remarks

This property defines the timeout when sending data. When SSLEnabled is False a value of 0 means data will be sent asynchronously and a positive value means data is sent synchronously. When SSLEnabled is True all data is sent synchronously regardless of the Timeout value. Please see the notes below for details.

Plaintext

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 component will wait for the operation to complete before returning control. The component will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

SSL

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

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

Additional Notes

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

If Timeout expires, and the operation is not yet complete, the component throws an exception.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TrustedCerts Property (OFTPClient Component)

A collection of trusted CA certificates.

Syntax

• C#
• VB.NET

public CertificateList TrustedCerts { get; }

Public Property TrustedCerts As CertificateList

Remarks

If this collection is populated the component will validate any certificates that are loaded against the CA certificates specified here.

If this collection is not populated no validation will occur. Certificates are imported into this collection by calling the ImportTrustedCerts method.

See also FailOnUntrustedCert and TrustedCertsData.

This property is not available at design time.

UseSSL Property (OFTPClient Component)

Use SSL to access the RemoteHost .

Syntax

• C#
• VB.NET

public bool UseSSL { get; set; }

Public Property UseSSL As Boolean

Default Value

False

Remarks

Use this property to determine whether the component 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.

Version Property (OFTPClient Component)

Which version of the OFTP protocol the component is using.

Syntax

• C#
• VB.NET

public OFTPClientVersions Version { get; set; }

enum OFTPClientVersions {
  oftpVer12,
  oftpVer13,
  oftpVer14,
  oftpVer20
}

Public Property Version As OftpclientVersions

Enum OFTPClientVersions
  oftpVer12
  oftpVer13
  oftpVer14
  oftpVer20
End Enum

Default Value

3

Remarks

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

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

VirtualFileDate Property (OFTPClient Component)

The date/time stamp for the virtual file.

Syntax

• C#
• VB.NET

public string VirtualFileDate { get; set; }

Public Property VirtualFileDate As 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

VirtualFileFormat Property (OFTPClient Component)

The structure of the outgoing file.

Syntax

• C#
• VB.NET

public OFTPClientVirtualFileFormats VirtualFileFormat { get; set; }

enum OFTPClientVirtualFileFormats {
  ffUnstructured,
  ffText,
  ffFixed,
  ffVariable
}

Public Property VirtualFileFormat As OftpclientVirtualFileFormats

Enum OFTPClientVirtualFileFormats
  ffUnstructured
  ffText
  ffFixed
  ffVariable
End Enum

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.

VirtualFileSecurityLevel Property (OFTPClient Component)

The level of security for the file.

Syntax

• C#
• VB.NET

public OFTPClientVirtualFileSecurityLevels VirtualFileSecurityLevel { get; set; }

enum OFTPClientVirtualFileSecurityLevels {
  slNone,
  slEncrypted,
  slSigned,
  slEncryptedAndSigned
}

Public Property VirtualFileSecurityLevel As OftpclientVirtualFileSecurityLevels

Enum OFTPClientVirtualFileSecurityLevels
  slNone
  slEncrypted
  slSigned
  slEncryptedAndSigned
End Enum

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.

ChangeDirection Method (OFTPClient Component)

Sends a Change Direction (CD) command.

Syntax

• C#
• VB.NET

public void ChangeDirection();

Async Version
public async Task ChangeDirection();
public async Task ChangeDirection(CancellationToken cancellationToken);

Public Sub ChangeDirection()

Async Version
Public Sub ChangeDirection() As Task
Public Sub ChangeDirection(cancellationToken As CancellationToken) As Task

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

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

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 (OFTPClient Component)

This method connects to the FTP server without logging in.

Syntax

• C#
• VB.NET

public void Connect();

Async Version
public async Task Connect();
public async Task Connect(CancellationToken cancellationToken);

Public Sub Connect()

Async Version
Public Sub Connect() As Task
Public Sub Connect(cancellationToken As CancellationToken) As Task

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

This method disconnects from the server without first logging off.

Syntax

• C#
• VB.NET

public void Disconnect();

Async Version
public async Task Disconnect();
public async Task Disconnect(CancellationToken cancellationToken);

Public Sub Disconnect()

Async Version
Public Sub Disconnect() As Task
Public Sub Disconnect(cancellationToken As CancellationToken) As Task

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

This method processes events from the internal message queue.

Syntax

• C#
• VB.NET

public void DoEvents();

Async Version
public async Task DoEvents();
public async Task DoEvents(CancellationToken cancellationToken);

Public Sub DoEvents()

Async Version
Public Sub DoEvents() As Task
Public Sub DoEvents(cancellationToken As CancellationToken) As Task

Remarks

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

ExchangeCertificate Method (OFTPClient Component)

Exchange a certificate with the remote host.

Syntax

• C#
• VB.NET

public void ExchangeCertificate(string certificateStore, int certificateExchangeType);

Async Version
public async Task ExchangeCertificate(string certificateStore, int certificateExchangeType);
public async Task ExchangeCertificate(string certificateStore, int certificateExchangeType, CancellationToken cancellationToken);

Public Sub ExchangeCertificate(ByVal CertificateStore As String, ByVal CertificateExchangeType As Integer)

Async Version
Public Sub ExchangeCertificate(ByVal CertificateStore As String, ByVal CertificateExchangeType As Integer) As Task
Public Sub ExchangeCertificate(ByVal CertificateStore As String, ByVal CertificateExchangeType As Integer, cancellationToken As CancellationToken) As Task

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:

ImportTrustedCerts Method (OFTPClient Component)

Imports a list of trusted CA certificates.

Syntax

• C#
• VB.NET

public void ImportTrustedCerts();

Async Version
public async Task ImportTrustedCerts();
public async Task ImportTrustedCerts(CancellationToken cancellationToken);

Public Sub ImportTrustedCerts()

Async Version
Public Sub ImportTrustedCerts() As Task
Public Sub ImportTrustedCerts(cancellationToken As CancellationToken) As Task

Remarks

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

The component 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 Component)

This method interrupts the current action.

Syntax

• C#
• VB.NET

public void Interrupt();

Async Version
public async Task Interrupt();
public async Task Interrupt(CancellationToken cancellationToken);

Public Sub Interrupt()

Async Version
Public Sub Interrupt() As Task
Public Sub Interrupt(cancellationToken As CancellationToken) As Task

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the component 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 Component)

Logoff from the OFTP server.

Syntax

• C#
• VB.NET

public void Logoff();

Async Version
public async Task Logoff();
public async Task Logoff(CancellationToken cancellationToken);

Public Sub Logoff()

Async Version
Public Sub Logoff() As Task
Public Sub Logoff(cancellationToken As CancellationToken) As Task

Remarks

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

Logon Method (OFTPClient Component)

Logon to the OFTP RemoteHost using the current client credentials.

Syntax

• C#
• VB.NET

public void Logon();

Async Version
public async Task Logon();
public async Task Logon(CancellationToken cancellationToken);

Public Sub Logon()

Async Version
Public Sub Logon() As Task
Public Sub Logon(cancellationToken As CancellationToken) As Task

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

Receive any files queued to be sent from the server.

Syntax

• C#
• VB.NET

public void ReceiveFiles();

Async Version
public async Task ReceiveFiles();
public async Task ReceiveFiles(CancellationToken cancellationToken);

Public Sub ReceiveFiles()

Async Version
Public Sub ReceiveFiles() As Task
Public Sub ReceiveFiles(cancellationToken As CancellationToken) As Task

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

Resets the state of the control.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SendEndResponse Method (OFTPClient Component)

Sends an EERP/NERP asynchronously.

Syntax

• C#
• VB.NET

public void SendEndResponse(string virtualFileName, string virtualFileDate, string destination, string originator, string creator, int reasonCode, string reasonText, string fileHash, string signature);

Async Version
public async Task SendEndResponse(string virtualFileName, string virtualFileDate, string destination, string originator, string creator, int reasonCode, string reasonText, string fileHash, string signature);
public async Task SendEndResponse(string virtualFileName, string virtualFileDate, string destination, string originator, string creator, int reasonCode, string reasonText, string fileHash, string signature, CancellationToken cancellationToken);

Public Sub SendEndResponse(ByVal VirtualFileName As String, ByVal VirtualFileDate As String, ByVal Destination As String, ByVal Originator As String, ByVal Creator As String, ByVal ReasonCode As Integer, ByVal ReasonText As String, ByVal FileHash As String, ByVal Signature As String)

Async Version
Public Sub SendEndResponse(ByVal VirtualFileName As String, ByVal VirtualFileDate As String, ByVal Destination As String, ByVal Originator As String, ByVal Creator As String, ByVal ReasonCode As Integer, ByVal ReasonText As String, ByVal FileHash As String, ByVal Signature As String) As Task
Public Sub SendEndResponse(ByVal VirtualFileName As String, ByVal VirtualFileDate As String, ByVal Destination As String, ByVal Originator As String, ByVal Creator As String, ByVal ReasonCode As Integer, ByVal ReasonText As String, ByVal FileHash As String, ByVal Signature As String, cancellationToken As CancellationToken) As Task

Remarks

This method sends an EERP/NERP. By default the component 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 component 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 component 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 component will send an EERP. If ReasonCode is set to any non-zero value the component will send a NERP. Common values are:

SendFile Method (OFTPClient Component)

Send the specified file to the server.

Syntax

• C#
• VB.NET

public void SendFile(string localFile, string virtualFileName);

Async Version
public async Task SendFile(string localFile, string virtualFileName);
public async Task SendFile(string localFile, string virtualFileName, CancellationToken cancellationToken);

Public Sub SendFile(ByVal LocalFile As String, ByVal VirtualFileName As String)

Async Version
Public Sub SendFile(ByVal LocalFile As String, ByVal VirtualFileName As String) As Task
Public Sub SendFile(ByVal LocalFile As String, ByVal VirtualFileName As String, cancellationToken As CancellationToken) As Task

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.

SetDownloadStream Method (OFTPClient Component)

Sets the stream to which the downloaded file is written.

Syntax

• C#
• VB.NET

public void SetDownloadStream(System.IO.Stream downloadStream);

Async Version
public async Task SetDownloadStream(System.IO.Stream downloadStream);
public async Task SetDownloadStream(System.IO.Stream downloadStream, CancellationToken cancellationToken);

Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream)

Async Version
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream) As Task
Public Sub SetDownloadStream(ByVal DownloadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

When set, the file data will be written to the stream when downloaded from the server. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is true (default).

It is recommended to call this method from within the AcceptFile event to ensure each received file is set to the intended stream object.

SetUploadStream Method (OFTPClient Component)

Sets the stream to be uploaded to the server.

Syntax

• C#
• VB.NET

public void SetUploadStream(System.IO.Stream uploadStream);

Async Version
public async Task SetUploadStream(System.IO.Stream uploadStream);
public async Task SetUploadStream(System.IO.Stream uploadStream, CancellationToken cancellationToken);

Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream)

Async Version
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream) As Task
Public Sub SetUploadStream(ByVal UploadStream As System.IO.Stream, cancellationToken As CancellationToken) As Task

Remarks

When set, the data will be read from the stream when uploaded to the server. The stream should be open and normally set to position 0.

The component will automatically close this stream if CloseStreamAfterTransfer is true (default). If the stream is closed, you will need to call SetUploadStream again before the next send.

The content of the stream will be read from the current position all the way to the end.

ValidateCert Method (OFTPClient Component)

Validates the certificate with private key.

Syntax

• C#
• VB.NET

public bool ValidateCert();

Async Version
public async Task<bool> ValidateCert();
public async Task<bool> ValidateCert(CancellationToken cancellationToken);

Public Function ValidateCert() As Boolean

Async Version
Public Function ValidateCert() As Task(Of Boolean)
Public Function ValidateCert(cancellationToken As CancellationToken) As Task(Of Boolean)

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

• 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 Component)

Validates the recipient certificate.

Syntax

• C#
• VB.NET

public bool ValidateRecipientCert();

Async Version
public async Task<bool> ValidateRecipientCert();
public async Task<bool> ValidateRecipientCert(CancellationToken cancellationToken);

Public Function ValidateRecipientCert() As Boolean

Async Version
Public Function ValidateRecipientCert() As Task(Of Boolean)
Public Function ValidateRecipientCert(cancellationToken As CancellationToken) As Task(Of Boolean)

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

• 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 Component)

Fired when the client receives a file.

Syntax

• C#
• VB.NET

public event OnAcceptFileHandler OnAcceptFile;

public delegate void OnAcceptFileHandler(object sender, OFTPClientAcceptFileEventArgs e);

public class OFTPClientAcceptFileEventArgs : EventArgs {
  public string VirtualFileName { get; }
  public string VirtualFileDate { get; }
  public string Destination { get; }
  public string Originator { get; }
  public bool Accept { get; set; }
  public string FileName { get; set; }
  public bool Overwrite { get; set; }
  public int ErrorCode { get; set; }
  public string ErrorDescription { get; set; }
}

Public Event OnAcceptFile As OnAcceptFileHandler

Public Delegate Sub OnAcceptFileHandler(sender As Object, e As OFTPClientAcceptFileEventArgs)

Public Class OFTPClientAcceptFileEventArgs Inherits EventArgs
  Public ReadOnly Property VirtualFileName As String
  Public ReadOnly Property VirtualFileDate As String
  Public ReadOnly Property Destination As String
  Public ReadOnly Property Originator As String
  Public Property Accept As Boolean
  Public Property FileName As String
  Public Property Overwrite As Boolean
  Public Property ErrorCode As Integer
  Public Property ErrorDescription As String
End Class

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 DownloadDirectory 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 component 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 component 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 Component)

Fired when a certificate is received from the remote host.

Syntax

• C#
• VB.NET

public event OnCertificateReceivedHandler OnCertificateReceived;

public delegate void OnCertificateReceivedHandler(object sender, OFTPClientCertificateReceivedEventArgs e);

public class OFTPClientCertificateReceivedEventArgs : EventArgs {
  public string CertificateFileName { get; }
  public int CertificateExchangeType { get; }
}

Public Event OnCertificateReceived As OnCertificateReceivedHandler

Public Delegate Sub OnCertificateReceivedHandler(sender As Object, e As OFTPClientCertificateReceivedEventArgs)

Public Class OFTPClientCertificateReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property CertificateFileName As String
  Public ReadOnly Property CertificateExchangeType As Integer
End Class

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

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

Syntax

• C#
• VB.NET

public event OnEndResponseHandler OnEndResponse;

public delegate void OnEndResponseHandler(object sender, OFTPClientEndResponseEventArgs e);

public class OFTPClientEndResponseEventArgs : EventArgs {
  public string VirtualFileName { get; }
  public string VirtualFileDate { get; }
  public string Destination { get; }
  public string Originator { get; }
  public string Creator { get; }
  public int ReasonCode { get; }
  public string ReasonText { get; }
  public string FileHash { get; set; }
  public string Signature { get; }
  public int Direction { get; }
}

Public Event OnEndResponse As OnEndResponseHandler

Public Delegate Sub OnEndResponseHandler(sender As Object, e As OFTPClientEndResponseEventArgs)

Public Class OFTPClientEndResponseEventArgs Inherits EventArgs
  Public ReadOnly Property VirtualFileName As String
  Public ReadOnly Property VirtualFileDate As String
  Public ReadOnly Property Destination As String
  Public ReadOnly Property Originator As String
  Public ReadOnly Property Creator As String
  Public ReadOnly Property ReasonCode As Integer
  Public ReadOnly Property ReasonText As String
  Public Property FileHash As String
  Public ReadOnly Property Signature As String
  Public ReadOnly Property Direction As Integer
End Class

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

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:

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

Fired when a file finishes transferring.

Syntax

• C#
• VB.NET

public event OnEndTransferHandler OnEndTransfer;

public delegate void OnEndTransferHandler(object sender, OFTPClientEndTransferEventArgs e);

public class OFTPClientEndTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string LocalFile { get; }
  public string VirtualFileName { get; }
  public string VirtualFileDate { get; }
  public string Destination { get; }
  public string Originator { get; }
  public int ReasonCode { get; }
  public string ReasonText { get; }
  public long FileSize { get; }
  public string FileHash { get; }
  public bool SendEndResponse { get; set; }
}

Public Event OnEndTransfer As OnEndTransferHandler

Public Delegate Sub OnEndTransferHandler(sender As Object, e As OFTPClientEndTransferEventArgs)

Public Class OFTPClientEndTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property LocalFile As String
  Public ReadOnly Property VirtualFileName As String
  Public ReadOnly Property VirtualFileDate As String
  Public ReadOnly Property Destination As String
  Public ReadOnly Property Originator As String
  Public ReadOnly Property ReasonCode As Integer
  Public ReadOnly Property ReasonText As String
  Public ReadOnly Property FileSize As Long
  Public ReadOnly Property FileHash As String
  Public Property SendEndResponse As Boolean
End Class

Remarks

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

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 component 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 Component)

Fired when information is available about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, OFTPClientErrorEventArgs e);

public class OFTPClientErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As OFTPClientErrorEventArgs)

Public Class OFTPClientErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

Log Event (OFTPClient Component)

Fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, OFTPClientLogEventArgs e);

public class OFTPClientLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As OFTPClientLogEventArgs)

Public Class OFTPClientLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

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

LogLevel indicates the level of message. Possible values are:

Message is the log entry.

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

• "Info"
• "OFTP"

PITrail Event (OFTPClient Component)

Fired when any protocol level communication occurs.

Syntax

• C#
• VB.NET

public event OnPITrailHandler OnPITrail;

public delegate void OnPITrailHandler(object sender, OFTPClientPITrailEventArgs e);

public class OFTPClientPITrailEventArgs : EventArgs {
  public int Direction { get; }
  public string Data { get; }
  public byte[] DataB { get; }
  public int CommandId { get; }
  public string CommandDescription { get; }
}

Public Event OnPITrail As OnPITrailHandler

Public Delegate Sub OnPITrailHandler(sender As Object, e As OFTPClientPITrailEventArgs)

Public Class OFTPClientPITrailEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property Data As String
  Public ReadOnly Property DataB As Byte()
  Public ReadOnly Property CommandId As Integer
  Public ReadOnly Property CommandDescription As String
End Class

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

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, OFTPClientSSLServerAuthenticationEventArgs e);

public class OFTPClientSSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As OFTPClientSSLServerAuthenticationEventArgs)

Public Class OFTPClientSSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

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

Fired when secure connection progress messages are available.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, OFTPClientSSLStatusEventArgs e);

public class OFTPClientSSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As OFTPClientSSLStatusEventArgs)

Public Class OFTPClientSSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

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

StartTransfer Event (OFTPClient Component)

Fired when a document starts transferring.

Syntax

• C#
• VB.NET

public event OnStartTransferHandler OnStartTransfer;

public delegate void OnStartTransferHandler(object sender, OFTPClientStartTransferEventArgs e);

public class OFTPClientStartTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string LocalFile { get; set; }
  public string VirtualFileName { get; }
  public string VirtualFileDate { get; }
  public string Destination { get; }
  public string Originator { get; }
}

Public Event OnStartTransfer As OnStartTransferHandler

Public Delegate Sub OnStartTransferHandler(sender As Object, e As OFTPClientStartTransferEventArgs)

Public Class OFTPClientStartTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public Property LocalFile As String
  Public ReadOnly Property VirtualFileName As String
  Public ReadOnly Property VirtualFileDate As String
  Public ReadOnly Property Destination As String
  Public ReadOnly Property Originator As String
End Class

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

Fired while a document transfers (delivers document).

Syntax

• C#
• VB.NET

public event OnTransferHandler OnTransfer;

public delegate void OnTransferHandler(object sender, OFTPClientTransferEventArgs e);

public class OFTPClientTransferEventArgs : EventArgs {
  public int Direction { get; }
  public string LocalFile { get; }
  public string VirtualFileName { get; }
  public string VirtualFileDate { get; }
  public string Destination { get; }
  public string Originator { get; }
  public long BytesTransferred { get; }
  public string Text { get; }
  public byte[] TextB { get; }
}

Public Event OnTransfer As OnTransferHandler

Public Delegate Sub OnTransferHandler(sender As Object, e As OFTPClientTransferEventArgs)

Public Class OFTPClientTransferEventArgs Inherits EventArgs
  Public ReadOnly Property Direction As Integer
  Public ReadOnly Property LocalFile As String
  Public ReadOnly Property VirtualFileName As String
  Public ReadOnly Property VirtualFileDate As String
  Public ReadOnly Property Destination As String
  Public ReadOnly Property Originator As String
  Public ReadOnly Property BytesTransferred As Long
  Public ReadOnly Property Text As String
  Public ReadOnly Property TextB As Byte()
End Class

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

• C#
• VB.NET

public Certificate();

Public Certificate()

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

• C#
• VB.NET

public Certificate(byte[] encoded);

Public Certificate(ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

• C#
• VB.NET

public Certificate(CertStoreTypes storeType, byte[] store, string storePassword, byte[] encoded);

Public Certificate(ByVal StoreType As CertStoreTypes, ByVal Store As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

Fields

Constructors

• C#
• VB.NET

public Firewall();

Public Firewall()

Config Settings (OFTPClient Component)

OFTPClient Config Settings

Base Config Settings

Trappable Errors (OFTPClient Component)

OFTPClient Errors

TCPClient Errors

TCP/IP Errors