FTPServer Component

Properties   Methods   Events   Config Settings   Errors  

The FTPServer component provides server-side functionality for FTP and FTPS protocols.

Syntax

nsoftware.SecureBlackbox.FTPServer

Remarks

FTPServer supports FTP (File Transfer Protocol) and FTPS (FTP-over-SSL) protocols. The FTPS protocol allows you to securely perform file transfer operations on the server over Transport Layer Security (TLS). TLS is a successor to the now deprecated SSL protocol, although the latter abbreviation is still widely used.

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.

Active Property (FTPServer Component)

Whether the server is active and can accept incoming connections.

Syntax

• C#
• VB.NET

public bool Active { get; }

Public ReadOnly Property Active As Boolean

Default Value

False

Remarks

This read-only property returns True if the FTPS server is running and listening for incoming connections, and False otherwise.

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

AllowAnonymous Property (FTPServer Component)

Allows and disallows anonymous connections.

Syntax

• C#
• VB.NET

public bool AllowAnonymous { get; set; }

Public Property AllowAnonymous As Boolean

Default Value

False

Remarks

Use this property to enable and disable support for anonymous connections.

ClientFileEntry Property (FTPServer Component)

A container for current file entry details.

Syntax

• C#
• VB.NET

public FTPListEntry ClientFileEntry { get; set; }

Public Property ClientFileEntry As FTPListEntry

Remarks

Use this object to specify file entry details for a file listing or attributes request, before committing them to the server with SetClientFileEntry method.

This property is not available at design time.

DataHost Property (FTPServer Component)

Host address for incoming data channel connections.

Syntax

• C#
• VB.NET

public string DataHost { get; set; }

Public Property DataHost As String

Default Value

""

Remarks

Use this property to specify the address for incoming data channel connections, if it is different to Host.

In some network environments, in particular, where the server is behind a NAT, there may be a requirement to use a different host address for data connections.

DataPortRangeFrom Property (FTPServer Component)

Specifies the lower port range bound for passive mode data connections.

Syntax

• C#
• VB.NET

public int DataPortRangeFrom { get; set; }

Public Property DataPortRangeFrom As Integer

Default Value

0

Remarks

Use this property in combination with DataPortRangeT to limit the port range for passive mode data connections. The value of 0 (zero) stands for no lower bound.

DataPortRangeTo Property (FTPServer Component)

Specifies the upper port range bound for passive mode data connections.

Syntax

• C#
• VB.NET

public int DataPortRangeTo { get; set; }

Public Property DataPortRangeTo As Integer

Default Value

0

Remarks

Use this property in combination with DataPortRangeFrom to limit the port range for passive mode data connections. The value of 0 (zero) stands for no upper bound.

ExternalCrypto Property (FTPServer Component)

Provides access to external signing and DC parameters.

Syntax

• C#
• VB.NET

public ExternalCrypto ExternalCrypto { get; }

Public ReadOnly Property ExternalCrypto As ExternalCrypto

Remarks

Use this property to tune-up remote cryptography settings. SecureBlackbox supports two independent types of external cryptography: synchronous (based on the ExternalSign event) and asynchronous (based on the DC protocol and the DCAuth signing component).

This property is read-only.

FIPSMode Property (FTPServer Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

HandshakeTimeout Property (FTPServer Component)

Specifies the handshake timeout in milliseconds.

Syntax

• C#
• VB.NET

public int HandshakeTimeout { get; set; }

Public Property HandshakeTimeout As Integer

Default Value

20000

Remarks

Use this property to set the TLS handshake timeout.

Host Property (FTPServer Component)

Specifies the server host.

Syntax

• C#
• VB.NET

public string Host { get; set; }

Public Property Host As String

Default Value

""

Remarks

Use this property to specify the IP address on which to listen for incoming FTP connections. Use Port to specify the listening port number.

ImplicitSSL Property (FTPServer Component)

Enables or disables implicit SSL mode.

Syntax

• C#
• VB.NET

public bool ImplicitSSL { get; set; }

Public Property ImplicitSSL As Boolean

Default Value

False

Remarks

The server can only work in one mode, explicit or implicit. Explicit mode, also called AUTH TLS, supports both TLS and plain connections. Implicit mode, also called 'dedicated port mode,' only supports TLS connections.

PassiveModeHost Property (FTPServer Component)

The IP address of the passive mode host.

Syntax

• C#
• VB.NET

public string PassiveModeHost { get; set; }

Public Property PassiveModeHost As String

Default Value

""

Remarks

Use this property to specify the address on which to listen for passive mode connections.

PinnedClient Property (FTPServer Component)

Populates the pinned client details.

Syntax

• C#
• VB.NET

public TLSConnectionInfo PinnedClient { get; }

Public ReadOnly Property PinnedClient As TLSConnectionInfo

Remarks

Use this property to access the details of the client connection previously pinned with PinClient method.

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

PinnedClientChain Property (FTPServer Component)

Contains the certificate chain of the pinned client.

Syntax

• C#
• VB.NET

public CertificateList PinnedClientChain { get; }

Public ReadOnly Property PinnedClientChain As CertificateList

Remarks

Use this property to access the certificate chain of the client connection pinned previously with a PinClient call.

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

Port Property (FTPServer Component)

The port number to listen for incoming connections on.

Syntax

• C#
• VB.NET

public int Port { get; set; }

Public Property Port As Integer

Default Value

21

Remarks

Use this property to specify the port number to listen for incoming connections on.

ReadOnly Property (FTPServer Component)

Makes the server's file system read-only for all users.

Syntax

• C#
• VB.NET

public bool ReadOnly { get; set; }

Public Property ReadOnly As Boolean

Default Value

False

Remarks

Set this property to true to present the server's file system as read-only for all connecting users.

RootDirectory Property (FTPServer Component)

Specifies the server's root directory.

Syntax

• C#
• VB.NET

public string RootDirectory { get; set; }

Public Property RootDirectory As String

Default Value

""

Remarks

Use this property to specify the shared root directory for all client sessions.

SecurityOptions Property (FTPServer Component)

Various options of the secure connection.

Syntax

• C#
• VB.NET

public int SecurityOptions { get; set; }

Public Property SecurityOptions As Integer

Default Value

63

Remarks

Various options of the secure connection:

SessionTimeout Property (FTPServer Component)

Specifies the session timeout in milliseconds.

Syntax

• C#
• VB.NET

public int SessionTimeout { get; set; }

Public Property SessionTimeout As Integer

Default Value

360000

Remarks

Specifies the maximum inactivity time (in milliseconds) after which the session will be forcebly closed.

SocketSettings Property (FTPServer Component)

Manages network connection settings.

Syntax

• C#
• VB.NET

public SocketSettings SocketSettings { get; }

Public ReadOnly Property SocketSettings As SocketSettings

Remarks

Use this property to tune up network connection parameters.

This property is read-only.

TLSServerChain Property (FTPServer Component)

The server's TLS certificates.

Syntax

• C#
• VB.NET

public CertificateList TLSServerChain { get; }

Public Property TLSServerChain As CertificateList

Remarks

Use this property to provide a list of TLS certificates for the server endpoint.

A TLS endpoint needs a certificate to be able to accept TLS connections. At least one of the certificates in the collection - the endpoint certificate - must have a private key associated with it.

The collection may include more than one endpoint certificate, and more than one chain. A typical usage scenario is to include two chains (ECDSA and RSA), to cater for clients with different cipher suite preferences.

This property is not available at design time.

TLSSettings Property (FTPServer Component)

Manages TLS layer settings.

Syntax

• C#
• VB.NET

public TLSSettings TLSSettings { get; }

Public ReadOnly Property TLSSettings As TLSSettings

Remarks

Use this property to tune up the TLS layer parameters.

This property is read-only.

Users Property (FTPServer Component)

Provides a list of registered users.

Syntax

• C#
• VB.NET

public UserAccountList Users { get; }

Public Property Users As UserAccountList

Remarks

Assign a list of 'known' users to this property to automate authentication handling by the component.

This property is not available at design time.

UseUTF8 Property (FTPServer Component)

Enables or disables UTF8 file name conversions.

Syntax

• C#
• VB.NET

public bool UseUTF8 { get; set; }

Public Property UseUTF8 As Boolean

Default Value

True

Remarks

Use this property to enable and disable UTF8 file name conversion. The server typically adjusts to the right setting automatically, but you may use this property to enforce the needed behaviour.

Cleanup Method (FTPServer Component)

Cleans up the server environment by purging expired sessions and cleaning caches.

Syntax

• C#
• VB.NET

public void Cleanup();

Public Sub Cleanup()

Remarks

Call this method while the server is active to clean up the environment allocated for the server by releasing unused resources and cleaning caches.

Config Method (FTPServer Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As 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.

DoAction Method (FTPServer Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

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

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

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

DropClient Method (FTPServer Component)

Terminates a client connection.

Syntax

• C#
• VB.NET

public void DropClient(long connectionId, bool forced);

Public Sub DropClient(ByVal ConnectionId As Long, ByVal Forced As Boolean)

Remarks

Call this method to shut down a connected client. Forced indicates whether the connection should be closed in a graceful manner.

GetClientBuffer Method (FTPServer Component)

Obtains a pending connection buffer.

Syntax

• C#
• VB.NET

public byte[] GetClientBuffer(long connectionID);

Public Function GetClientBuffer(ByVal ConnectionID As Long) As Byte()

Remarks

Use this method to obtain a pending connection buffer from your WriteFile event handler. The connection buffer contains data that have been received from the client but has not been written to the file yet.

ListClients Method (FTPServer Component)

Enumerates the connected clients.

Syntax

• C#
• VB.NET

public string ListClients();

Public Function ListClients() As String

Remarks

This method enumerates the connected clients. It returns a list of strings, with each string being of 'ConnectionID|Address|Port' format, and representing a single connection.

PinClient Method (FTPServer Component)

Takes a snapshot of the connection's properties.

Syntax

• C#
• VB.NET

public void PinClient(long connectionId);

Public Sub PinClient(ByVal ConnectionId As Long)

Remarks

Use this method to take a snapshot of a connected client. The captured properties are populated in PinnedClient and PinnedClientChain properties.

Reset Method (FTPServer Component)

Resets the component settings.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Reset is a generic method available in every component.

SetClientBuffer Method (FTPServer Component)

Commits a data buffer to the connection.

Syntax

• C#
• VB.NET

public void SetClientBuffer(long connectionID, byte[] value);

Public Sub SetClientBuffer(ByVal ConnectionID As Long, ByVal Value As Byte())

Remarks

Use this method from your ReadFile event handler to commit a chunk of file data to the server component.

SetClientFileEntry Method (FTPServer Component)

Commits a file entry to the connection.

Syntax

• C#
• VB.NET

public void SetClientFileEntry(long connectionID);

Public Sub SetClientFileEntry(ByVal ConnectionID As Long)

Remarks

Use this method to commit a file details entry provided in ClientFileEntry property to ConnectionID connection. This method is supposed to be used from a FindNext event handler.

Please note that events like FindNext may be invoked concurrently for several connection threads. Please make sure you use a locking mechanism to avoid mixing up details in ClientFileEntry.

Start Method (FTPServer Component)

Starts the server.

Syntax

• C#
• VB.NET

public void Start();

Public Sub Start()

Remarks

Call this method to start listening for incoming connections on port Port. Call Stop to deactivate the server.

Stop Method (FTPServer Component)

Stops the server.

Syntax

• C#
• VB.NET

public void Stop();

Public Sub Stop()

Remarks

Call this method to terminate all active sessions and stop listening for new incoming connections.

Accept Event (FTPServer Component)

Reports an incoming connection.

Syntax

• C#
• VB.NET

public event OnAcceptHandler OnAccept;

public delegate void OnAcceptHandler(object sender, FTPServerAcceptEventArgs e);

public class FTPServerAcceptEventArgs : EventArgs {
  public string RemoteAddress { get; }
  public int RemotePort { get; }
  public bool Accept { get; set; }
}

Public Event OnAccept As OnAcceptHandler

Public Delegate Sub OnAcceptHandler(sender As Object, e As FTPServerAcceptEventArgs)

Public Class FTPServerAcceptEventArgs Inherits EventArgs
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property RemotePort As Integer
  Public Property Accept As Boolean
End Class

Remarks

This event is fired when a new connection from RemoteAddress:RemotePort is ready to be accepted. Use the Accept parameter to accept or decline it.

Subscribe to Connect event to be notified of every connection that has been set up.

AfterChangeDirectory Event (FTPServer Component)

Signals the completion of a directory change operation.

Syntax

• C#
• VB.NET

public event OnAfterChangeDirectoryHandler OnAfterChangeDirectory;

public delegate void OnAfterChangeDirectoryHandler(object sender, FTPServerAfterChangeDirectoryEventArgs e);

public class FTPServerAfterChangeDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterChangeDirectory As OnAfterChangeDirectoryHandler

Public Delegate Sub OnAfterChangeDirectoryHandler(sender As Object, e As FTPServerAfterChangeDirectoryEventArgs)

Public Class FTPServerAfterChangeDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Directory As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event upon completion of a directory change operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterCreateDirectory Event (FTPServer Component)

Signals the completion of a directory creation operation.

Syntax

• C#
• VB.NET

public event OnAfterCreateDirectoryHandler OnAfterCreateDirectory;

public delegate void OnAfterCreateDirectoryHandler(object sender, FTPServerAfterCreateDirectoryEventArgs e);

public class FTPServerAfterCreateDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterCreateDirectory As OnAfterCreateDirectoryHandler

Public Delegate Sub OnAfterCreateDirectoryHandler(sender As Object, e As FTPServerAfterCreateDirectoryEventArgs)

Public Class FTPServerAfterCreateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Directory As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event upon completion of a directory creation operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveDirectory Event (FTPServer Component)

Signals the completion of a directory removal operation.

Syntax

• C#
• VB.NET

public event OnAfterRemoveDirectoryHandler OnAfterRemoveDirectory;

public delegate void OnAfterRemoveDirectoryHandler(object sender, FTPServerAfterRemoveDirectoryEventArgs e);

public class FTPServerAfterRemoveDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRemoveDirectory As OnAfterRemoveDirectoryHandler

Public Delegate Sub OnAfterRemoveDirectoryHandler(sender As Object, e As FTPServerAfterRemoveDirectoryEventArgs)

Public Class FTPServerAfterRemoveDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Directory As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event upon completion of a directory removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRemoveFile Event (FTPServer Component)

Signals the completion of a file removal operation.

Syntax

• C#
• VB.NET

public event OnAfterRemoveFileHandler OnAfterRemoveFile;

public delegate void OnAfterRemoveFileHandler(object sender, FTPServerAfterRemoveFileEventArgs e);

public class FTPServerAfterRemoveFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRemoveFile As OnAfterRemoveFileHandler

Public Delegate Sub OnAfterRemoveFileHandler(sender As Object, e As FTPServerAfterRemoveFileEventArgs)

Public Class FTPServerAfterRemoveFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event upon completion of a file removal operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRenameFile Event (FTPServer Component)

Signals the completion of a file renaming operation.

Syntax

• C#
• VB.NET

public event OnAfterRenameFileHandler OnAfterRenameFile;

public delegate void OnAfterRenameFileHandler(object sender, FTPServerAfterRenameFileEventArgs e);

public class FTPServerAfterRenameFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRenameFile As OnAfterRenameFileHandler

Public Delegate Sub OnAfterRenameFileHandler(sender As Object, e As FTPServerAfterRenameFileEventArgs)

Public Class FTPServerAfterRenameFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event upon completion of a file renaming operation. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AfterRequestAttributes Event (FTPServer Component)

Signals the completion of an attribute request.

Syntax

• C#
• VB.NET

public event OnAfterRequestAttributesHandler OnAfterRequestAttributes;

public delegate void OnAfterRequestAttributesHandler(object sender, FTPServerAfterRequestAttributesEventArgs e);

public class FTPServerAfterRequestAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnAfterRequestAttributes As OnAfterRequestAttributesHandler

Public Delegate Sub OnAfterRequestAttributesHandler(sender As Object, e As FTPServerAfterRequestAttributesEventArgs)

Public Class FTPServerAfterRequestAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event upon completion of an attribute request. Check the operation status, and alter it, if needed, through the OperationStatus parameter:

AuthAttempt Event (FTPServer Component)

Fires when a connected client makes an authentication attempt.

Syntax

• C#
• VB.NET

public event OnAuthAttemptHandler OnAuthAttempt;

public delegate void OnAuthAttemptHandler(object sender, FTPServerAuthAttemptEventArgs e);

public class FTPServerAuthAttemptEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Username { get; }
  public string Password { get; }
  public bool Allow { get; set; }
  public string BasePath { get; set; }
}

Public Event OnAuthAttempt As OnAuthAttemptHandler

Public Delegate Sub OnAuthAttemptHandler(sender As Object, e As FTPServerAuthAttemptEventArgs)

Public Class FTPServerAuthAttemptEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Username As String
  Public ReadOnly Property Password As String
  Public Property Allow As Boolean
  Public Property BasePath As String
End Class

Remarks

The component fires this event whenever a client attempts to authenticate itself. Use the Allow parameter to let the client through.

The BasePath parameter specifies the home directory that will be used for this client. This is taken from the client's record in Users, or from RootDirectory if the client is not present in the list. You can adjust it in the event handler if required.

ConnectionID contains the unique session identifier for that client, and Username and Password contain the professed credentials.

BeforeChangeDirectory Event (FTPServer Component)

Notifies about an incoming change directory request.

Syntax

• C#
• VB.NET

public event OnBeforeChangeDirectoryHandler OnBeforeChangeDirectory;

public delegate void OnBeforeChangeDirectoryHandler(object sender, FTPServerBeforeChangeDirectoryEventArgs e);

public class FTPServerBeforeChangeDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; }
  public int Action { get; set; }
}

Public Event OnBeforeChangeDirectory As OnBeforeChangeDirectoryHandler

Public Delegate Sub OnBeforeChangeDirectoryHandler(sender As Object, e As FTPServerBeforeChangeDirectoryEventArgs)

Public Class FTPServerBeforeChangeDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Directory As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received directory change request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to ChangeDirectory to be notified when to perform the request. It is the ChangeDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterChangeDirectory event will be fired.

Choose Action as one of the following values:

BeforeCreateDirectory Event (FTPServer Component)

Notifies about an incoming create directory request.

Syntax

• C#
• VB.NET

public event OnBeforeCreateDirectoryHandler OnBeforeCreateDirectory;

public delegate void OnBeforeCreateDirectoryHandler(object sender, FTPServerBeforeCreateDirectoryEventArgs e);

public class FTPServerBeforeCreateDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; }
  public int Action { get; set; }
}

Public Event OnBeforeCreateDirectory As OnBeforeCreateDirectoryHandler

Public Delegate Sub OnBeforeCreateDirectoryHandler(sender As Object, e As FTPServerBeforeCreateDirectoryEventArgs)

Public Class FTPServerBeforeCreateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Directory As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received MKDIR request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to CreateDirectory to be notified when to perform the request. It is the CreateDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterCreateDirectory event will be fired.

Choose Action as one of the following values:

BeforeDownloadFile Event (FTPServer Component)

Notifies about an incoming file download request.

Syntax

• C#
• VB.NET

public event OnBeforeDownloadFileHandler OnBeforeDownloadFile;

public delegate void OnBeforeDownloadFileHandler(object sender, FTPServerBeforeDownloadFileEventArgs e);

public class FTPServerBeforeDownloadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public long RestartAt { get; }
  public int Action { get; set; }
}

Public Event OnBeforeDownloadFile As OnBeforeDownloadFileHandler

Public Delegate Sub OnBeforeDownloadFileHandler(sender As Object, e As FTPServerBeforeDownloadFileEventArgs)

Public Class FTPServerBeforeDownloadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property RestartAt As Long
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received download request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to DownloadFile to be notified when to perform the request. It is the DownloadFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.

Choose Action as one of the following values:

BeforeFind Event (FTPServer Component)

Notifies about an incoming file listing request.

Syntax

• C#
• VB.NET

public event OnBeforeFindHandler OnBeforeFind;

public delegate void OnBeforeFindHandler(object sender, FTPServerBeforeFindEventArgs e);

public class FTPServerBeforeFindEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; }
  public int Action { get; set; }
}

Public Event OnBeforeFind As OnBeforeFindHandler

Public Delegate Sub OnBeforeFindHandler(sender As Object, e As FTPServerBeforeFindEventArgs)

Public Class FTPServerBeforeFindEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Directory As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received file listing request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to FindInit, FindNext, and FindClose to be notified when to perform the request. It is the FindInit and FindNext events handler where you should perform the overridden listing actions.

Upon completion of the request, either in manual or override mode, the FindClose event will be fired.

Choose Action as one of the following values:

BeforeRemoveDirectory Event (FTPServer Component)

Notifies about an incoming directory removal request.

Syntax

• C#
• VB.NET

public event OnBeforeRemoveDirectoryHandler OnBeforeRemoveDirectory;

public delegate void OnBeforeRemoveDirectoryHandler(object sender, FTPServerBeforeRemoveDirectoryEventArgs e);

public class FTPServerBeforeRemoveDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRemoveDirectory As OnBeforeRemoveDirectoryHandler

Public Delegate Sub OnBeforeRemoveDirectoryHandler(sender As Object, e As FTPServerBeforeRemoveDirectoryEventArgs)

Public Class FTPServerBeforeRemoveDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Directory As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received directory removal request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RemoveDirectory to be notified when to perform the request. It is the RemoveDirectory event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRemoveDirectory event will be fired.

Choose Action as one of the following values:

BeforeRemoveFile Event (FTPServer Component)

Notifies about an incoming file removal request.

Syntax

• C#
• VB.NET

public event OnBeforeRemoveFileHandler OnBeforeRemoveFile;

public delegate void OnBeforeRemoveFileHandler(object sender, FTPServerBeforeRemoveFileEventArgs e);

public class FTPServerBeforeRemoveFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRemoveFile As OnBeforeRemoveFileHandler

Public Delegate Sub OnBeforeRemoveFileHandler(sender As Object, e As FTPServerBeforeRemoveFileEventArgs)

Public Class FTPServerBeforeRemoveFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received file deletion request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RemoveFile to be notified when to perform the request. It is the RemoveFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRemoveFile event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the deletion procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRenameFile Event (FTPServer Component)

Notifies about an incoming file rename request.

Syntax

• C#
• VB.NET

public event OnBeforeRenameFileHandler OnBeforeRenameFile;

public delegate void OnBeforeRenameFileHandler(object sender, FTPServerBeforeRenameFileEventArgs e);

public class FTPServerBeforeRenameFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRenameFile As OnBeforeRenameFileHandler

Public Delegate Sub OnBeforeRenameFileHandler(sender As Object, e As FTPServerBeforeRenameFileEventArgs)

Public Class FTPServerBeforeRenameFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received file rename request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RenameFile to be notified when to perform the request. It is the RenameFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRenameFile event will be fired.

Choose Action as one of the following values:

Note that you must subscribe to BeforeRequestAttributes and RequestAttributes events to be able to use this event in an FTP server attached to a virtual file system. This is because the server checks the existence of the source file before commencing the renaming procedure. In the virtualized case, you can confirm the existence of the file by returning its details from RequestAttributes call.

BeforeRequestAttributes Event (FTPServer Component)

Notifies about an incoming attributes request.

Syntax

• C#
• VB.NET

public event OnBeforeRequestAttributesHandler OnBeforeRequestAttributes;

public delegate void OnBeforeRequestAttributesHandler(object sender, FTPServerBeforeRequestAttributesEventArgs e);

public class FTPServerBeforeRequestAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int Action { get; set; }
}

Public Event OnBeforeRequestAttributes As OnBeforeRequestAttributesHandler

Public Delegate Sub OnBeforeRequestAttributesHandler(sender As Object, e As FTPServerBeforeRequestAttributesEventArgs)

Public Class FTPServerBeforeRequestAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received attributes request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to RequestAttributes to be notified when to perform the request. It is the RequestAttributes event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the AfterRequestAttributes event will be fired.

Choose Action as one of the following values:

BeforeSendReply Event (FTPServer Component)

Notifies the application of a command reply being sent.

Syntax

• C#
• VB.NET

public event OnBeforeSendReplyHandler OnBeforeSendReply;

public delegate void OnBeforeSendReplyHandler(object sender, FTPServerBeforeSendReplyEventArgs e);

public class FTPServerBeforeSendReplyEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int Code { get; set; }
  public string Reply { get; set; }
  public string Command { get; }
}

Public Event OnBeforeSendReply As OnBeforeSendReplyHandler

Public Delegate Sub OnBeforeSendReplyHandler(sender As Object, e As FTPServerBeforeSendReplyEventArgs)

Public Class FTPServerBeforeSendReplyEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Code As Integer
  Public Property Reply As String
  Public ReadOnly Property Command As String
End Class

Remarks

The component fires this event to tell the application that a command reply is about to be sent. The Command parameter indicates the command that induced the reply, and Code and Reply indicate the pre-generated response.

You can alter the response parameters in your code to send bespoke replies.

BeforeUploadFile Event (FTPServer Component)

Notifies about an incoming file upload request.

Syntax

• C#
• VB.NET

public event OnBeforeUploadFileHandler OnBeforeUploadFile;

public delegate void OnBeforeUploadFileHandler(object sender, FTPServerBeforeUploadFileEventArgs e);

public class FTPServerBeforeUploadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public long RestartAt { get; }
  public bool Append { get; }
  public int Action { get; set; }
}

Public Event OnBeforeUploadFile As OnBeforeUploadFileHandler

Public Delegate Sub OnBeforeUploadFileHandler(sender As Object, e As FTPServerBeforeUploadFileEventArgs)

Public Class FTPServerBeforeUploadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property RestartAt As Long
  Public ReadOnly Property Append As Boolean
  Public Property Action As Integer
End Class

Remarks

The component fires this event to notify the application about a received upload request. ConnectionID identifies the connected client.

Set Action to fraAuto to let the server handle the request automatically, or to fraCustom to handle the request in your code. Subscribe to UploadFile to be notified when to perform the request. It is the UploadFile event handler where you should perform the overridden action.

Upon completion of the request, either in manual or override mode, the TransferCompleted event will be fired.

Choose Action as one of the following values:

ChangeDirectory Event (FTPServer Component)

An override for a directory change operation.

Syntax

• C#
• VB.NET

public event OnChangeDirectoryHandler OnChangeDirectory;

public delegate void OnChangeDirectoryHandler(object sender, FTPServerChangeDirectoryEventArgs e);

public class FTPServerChangeDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnChangeDirectory As OnChangeDirectoryHandler

Public Delegate Sub OnChangeDirectoryHandler(sender As Object, e As FTPServerChangeDirectoryEventArgs)

Public Class FTPServerChangeDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Directory As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application perform an overridden directory change operation.

This event only fires if Action = fraCustom was passed back from BeforeChangeDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterChangeDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

CommandProcessed Event (FTPServer Component)

Signals that a command has been processed by the server.

Syntax

• C#
• VB.NET

public event OnCommandProcessedHandler OnCommandProcessed;

public delegate void OnCommandProcessedHandler(object sender, FTPServerCommandProcessedEventArgs e);

public class FTPServerCommandProcessedEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string CurrentDirectory { get; }
  public string Command { get; }
  public int ReplyCode { get; }
}

Public Event OnCommandProcessed As OnCommandProcessedHandler

Public Delegate Sub OnCommandProcessedHandler(sender As Object, e As FTPServerCommandProcessedEventArgs)

Public Class FTPServerCommandProcessedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property CurrentDirectory As String
  Public ReadOnly Property Command As String
  Public ReadOnly Property ReplyCode As Integer
End Class

Remarks

The component fires this event to signal that a command has been processed by the server, and a reply code has been generated.

You can adjust the reply code and the textual comment associated with it in BeforeSendReply event handler.

CommandReceived Event (FTPServer Component)

Signals that a command has been received from the client.

Syntax

• C#
• VB.NET

public event OnCommandReceivedHandler OnCommandReceived;

public delegate void OnCommandReceivedHandler(object sender, FTPServerCommandReceivedEventArgs e);

public class FTPServerCommandReceivedEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Command { get; }
  public string Parameters { get; }
  public bool Ignore { get; set; }
}

Public Event OnCommandReceived As OnCommandReceivedHandler

Public Delegate Sub OnCommandReceivedHandler(sender As Object, e As FTPServerCommandReceivedEventArgs)

Public Class FTPServerCommandReceivedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Command As String
  Public ReadOnly Property Parameters As String
  Public Property Ignore As Boolean
End Class

Remarks

The component fires this event to notify the application of an incoming command. Set Ignore to True to stop the server from handling the command.

When the command has been processed, the server will report it via the CommandProcessed call.

Connect Event (FTPServer Component)

Reports an accepted connection.

Syntax

• C#
• VB.NET

public event OnConnectHandler OnConnect;

public delegate void OnConnectHandler(object sender, FTPServerConnectEventArgs e);

public class FTPServerConnectEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string RemoteAddress { get; }
  public int Port { get; }
}

Public Event OnConnect As OnConnectHandler

Public Delegate Sub OnConnectHandler(sender As Object, e As FTPServerConnectEventArgs)

Public Class FTPServerConnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property RemoteAddress As String
  Public ReadOnly Property Port As Integer
End Class

Remarks

The component fires this event to report that a new connection has been established. ConnectionId indicates the unique ID assigned to this connection. The same ID will be supplied to any other events related to this connection, such as AuthAttempt or BeforeUploadFile.

CreateDirectory Event (FTPServer Component)

An override for a directory creation operation.

Syntax

• C#
• VB.NET

public event OnCreateDirectoryHandler OnCreateDirectory;

public delegate void OnCreateDirectoryHandler(object sender, FTPServerCreateDirectoryEventArgs e);

public class FTPServerCreateDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnCreateDirectory As OnCreateDirectoryHandler

Public Delegate Sub OnCreateDirectoryHandler(sender As Object, e As FTPServerCreateDirectoryEventArgs)

Public Class FTPServerCreateDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Directory As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application perform an overridden directory creation operation.

This event only fires if Action = fraCustom was passed back from BeforeCreateDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterCreateDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Disconnect Event (FTPServer Component)

Fires to report a disconnected client.

Syntax

• C#
• VB.NET

public event OnDisconnectHandler OnDisconnect;

public delegate void OnDisconnectHandler(object sender, FTPServerDisconnectEventArgs e);

public class FTPServerDisconnectEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnDisconnect As OnDisconnectHandler

Public Delegate Sub OnDisconnectHandler(sender As Object, e As FTPServerDisconnectEventArgs)

Public Class FTPServerDisconnectEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

The component fires this event when a connected client disconnects.

DownloadBegin Event (FTPServer Component)

The component fires this event to notify the application about the start of a file download.

Syntax

• C#
• VB.NET

public event OnDownloadBeginHandler OnDownloadBegin;

public delegate void OnDownloadBeginHandler(object sender, FTPServerDownloadBeginEventArgs e);

public class FTPServerDownloadBeginEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
}

Public Event OnDownloadBegin As OnDownloadBeginHandler

Public Delegate Sub OnDownloadBeginHandler(sender As Object, e As FTPServerDownloadBeginEventArgs)

Public Class FTPServerDownloadBeginEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
End Class

Remarks

Subscribe to this event to get notified about the beginning of a file download operation. The requested file is specified via the Path property.

DownloadEnd Event (FTPServer Component)

Reports the completion of the download operation.

Syntax

• C#
• VB.NET

public event OnDownloadEndHandler OnDownloadEnd;

public delegate void OnDownloadEndHandler(object sender, FTPServerDownloadEndEventArgs e);

public class FTPServerDownloadEndEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
}

Public Event OnDownloadEnd As OnDownloadEndHandler

Public Delegate Sub OnDownloadEndHandler(sender As Object, e As FTPServerDownloadEndEventArgs)

Public Class FTPServerDownloadEndEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
End Class

Remarks

Use this event to get notified about completion of the early initiated file download operation.

DownloadFile Event (FTPServer Component)

An override for a file download initiation operation.

Syntax

• C#
• VB.NET

public event OnDownloadFileHandler OnDownloadFile;

public delegate void OnDownloadFileHandler(object sender, FTPServerDownloadFileEventArgs e);

public class FTPServerDownloadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public long RestartAt { get; }
  public int OperationStatus { get; set; }
}

Public Event OnDownloadFile As OnDownloadFileHandler

Public Delegate Sub OnDownloadFileHandler(sender As Object, e As FTPServerDownloadFileEventArgs)

Public Class FTPServerDownloadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property RestartAt As Long
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application perform an overridden file download initiation operation.

This event only fires if Action = fraCustom was passed back from BeforeDownloadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of ReadFile calls, requesting the file data from your code, followed by a single TransferCompleted call.

Set OperationStatus to one of the following values:

DownloadProgress Event (FTPServer Component)

Reports the progress of an active download operation.

Syntax

• C#
• VB.NET

public event OnDownloadProgressHandler OnDownloadProgress;

public delegate void OnDownloadProgressHandler(object sender, FTPServerDownloadProgressEventArgs e);

public class FTPServerDownloadProgressEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public long Progress { get; }
  public long Total { get; }
}

Public Event OnDownloadProgress As OnDownloadProgressHandler

Public Delegate Sub OnDownloadProgressHandler(sender As Object, e As FTPServerDownloadProgressEventArgs)

Public Class FTPServerDownloadProgressEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Progress As Long
  Public ReadOnly Property Total As Long
End Class

Remarks

Subscribe to this event to be notified about the progress of an active download operation.

The Path parameter contains the path to the file being downloaded, and Progress and Total reflect the operation progress. Note that the Total parameter may be set to -1 if the size of the downloaded file is not known.

Error Event (FTPServer Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

public class FTPServerErrorEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int ErrorCode { get; }
  public bool Fatal { get; }
  public bool Remote { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

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

Public Class FTPServerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Fatal As Boolean
  Public ReadOnly Property Remote As Boolean
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

ExternalSign Event (FTPServer Component)

Handles remote or external signing initiated by the server protocol.

Syntax

• C#
• VB.NET

public event OnExternalSignHandler OnExternalSign;

public delegate void OnExternalSignHandler(object sender, FTPServerExternalSignEventArgs e);

public class FTPServerExternalSignEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OperationId { get; }
  public string HashAlgorithm { get; }
  public string Pars { get; }
  public string Data { get; }
  public string SignedData { get; set; }
}

Public Event OnExternalSign As OnExternalSignHandler

Public Delegate Sub OnExternalSignHandler(sender As Object, e As FTPServerExternalSignEventArgs)

Public Class FTPServerExternalSignEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OperationId As String
  Public ReadOnly Property HashAlgorithm As String
  Public ReadOnly Property Pars As String
  Public ReadOnly Property Data As String
  Public Property SignedData As String
End Class

Remarks

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

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

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

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

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

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

FindClose Event (FTPServer Component)

Signals the completion of a directory listing request.

Syntax

• C#
• VB.NET

public event OnFindCloseHandler OnFindClose;

public delegate void OnFindCloseHandler(object sender, FTPServerFindCloseEventArgs e);

public class FTPServerFindCloseEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int OperationStatus { get; set; }
}

Public Event OnFindClose As OnFindCloseHandler

Public Delegate Sub OnFindCloseHandler(sender As Object, e As FTPServerFindCloseEventArgs)

Public Class FTPServerFindCloseEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event upon completion of a directory listing request. Check the operation status, and alter it, if needed, through the OperationStatus parameter.

FindInit Event (FTPServer Component)

An override for a directory listing initiation operation.

Syntax

• C#
• VB.NET

public event OnFindInitHandler OnFindInit;

public delegate void OnFindInitHandler(object sender, FTPServerFindInitEventArgs e);

public class FTPServerFindInitEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnFindInit As OnFindInitHandler

Public Delegate Sub OnFindInitHandler(sender As Object, e As FTPServerFindInitEventArgs)

Public Class FTPServerFindInitEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Directory As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application prepare for directory listing retrieval.

This event only fires if Action = fraCustom was passed back from BeforeFind event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of FindNext calls, requesting the directory listing entry by entry from your code, followed by a FindClose call.

Set OperationStatus to one of the following values:

FindNext Event (FTPServer Component)

An override for a directory listing entry request operation.

Syntax

• C#
• VB.NET

public event OnFindNextHandler OnFindNext;

public delegate void OnFindNextHandler(object sender, FTPServerFindNextEventArgs e);

public class FTPServerFindNextEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int OperationStatus { get; set; }
}

Public Event OnFindNext As OnFindNextHandler

Public Delegate Sub OnFindNextHandler(sender As Object, e As FTPServerFindNextEventArgs)

Public Class FTPServerFindNextEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event in a loop after calling FindInit to request one directory entry from the application.

This event only fires if Action = fraCustom was passed back from BeforeFind event. No default listing operation will be performed by the server component.

Inside the handler, pass the entry details to the server component by tuning up the ClientFileEntry object to contain the details of the requested entry, and committing those details to the component with SetClientFileEntry method.

Use the OperationStatus parameter to return the operation result back to the server. After submitting all the directory entries to the component, set OperationStatus to ostEOF to tell the components that no more entries are left.

This event will be followed by FindClose call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Notification Event (FTPServer Component)

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

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, FTPServerNotificationEventArgs e);

public class FTPServerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As FTPServerNotificationEventArgs)

Public Class FTPServerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

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

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

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

ReadFile Event (FTPServer Component)

Requests a piece of file data from the application.

Syntax

• C#
• VB.NET

public event OnReadFileHandler OnReadFile;

public delegate void OnReadFileHandler(object sender, FTPServerReadFileEventArgs e);

public class FTPServerReadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int Size { get; }
  public int OperationStatus { get; set; }
}

Public Event OnReadFile As OnReadFileHandler

Public Delegate Sub OnReadFileHandler(sender As Object, e As FTPServerReadFileEventArgs)

Public Class FTPServerReadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Size As Integer
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event repeatedly during an overridden download operation to request file data from the application.

The handler of this event should read up to Size bytes from the downloaded file, and pass them to the component with a SetClientBuffer call.

Use the OperationStatus parameter to return the operation result back to the server. When the file has been read up to its end, set OperationStatus to ostEOF to tell the components that no more ReadFile calls are needed.

Set OperationStatus to one of the following values:

RemoveDirectory Event (FTPServer Component)

An override for a directory removal operation.

Syntax

• C#
• VB.NET

public event OnRemoveDirectoryHandler OnRemoveDirectory;

public delegate void OnRemoveDirectoryHandler(object sender, FTPServerRemoveDirectoryEventArgs e);

public class FTPServerRemoveDirectoryEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Directory { get; set; }
  public int OperationStatus { get; set; }
}

Public Event OnRemoveDirectory As OnRemoveDirectoryHandler

Public Delegate Sub OnRemoveDirectoryHandler(sender As Object, e As FTPServerRemoveDirectoryEventArgs)

Public Class FTPServerRemoveDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Directory As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application perform an overridden directory removal operation.

This event only fires if Action = fraCustom was passed back from BeforeRemoveDirectory event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRemoveDirectory call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

RemoveFile Event (FTPServer Component)

An override for a file remove operation.

Syntax

• C#
• VB.NET

public event OnRemoveFileHandler OnRemoveFile;

public delegate void OnRemoveFileHandler(object sender, FTPServerRemoveFileEventArgs e);

public class FTPServerRemoveFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRemoveFile As OnRemoveFileHandler

Public Delegate Sub OnRemoveFileHandler(sender As Object, e As FTPServerRemoveFileEventArgs)

Public Class FTPServerRemoveFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application perform an overridden file removal operation.

This event only fires if Action = fraCustom was passed back from BeforeRemoveFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRemoveFile call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file removals in the BeforeRemoveFile topic.

RenameFile Event (FTPServer Component)

An override for a file rename operation.

Syntax

• C#
• VB.NET

public event OnRenameFileHandler OnRenameFile;

public delegate void OnRenameFileHandler(object sender, FTPServerRenameFileEventArgs e);

public class FTPServerRenameFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string OldPath { get; }
  public string NewPath { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRenameFile As OnRenameFileHandler

Public Delegate Sub OnRenameFileHandler(sender As Object, e As FTPServerRenameFileEventArgs)

Public Class FTPServerRenameFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property OldPath As String
  Public ReadOnly Property NewPath As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application perform an overridden file rename operation.

This event only fires if Action = fraCustom was passed back from BeforeRenameFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRenameFile call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

Please see a remark about virtualizing file renamings in the BeforeRenameFile topic.

RequestAttributes Event (FTPServer Component)

An override for an attribute request.

Syntax

• C#
• VB.NET

public event OnRequestAttributesHandler OnRequestAttributes;

public delegate void OnRequestAttributesHandler(object sender, FTPServerRequestAttributesEventArgs e);

public class FTPServerRequestAttributesEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public int OperationStatus { get; set; }
}

Public Event OnRequestAttributes As OnRequestAttributesHandler

Public Delegate Sub OnRequestAttributesHandler(sender As Object, e As FTPServerRequestAttributesEventArgs)

Public Class FTPServerRequestAttributesEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application handle an overridden attribute request operation.

This event only fires if Action = fraCustom was passed back from BeforeRequestAttributes event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by AfterRequestAttributes call which will let you make final adjustments to the returned code.

Set OperationStatus to one of the following values:

TLSCertValidate Event (FTPServer Component)

Fires when a client certificate needs to be validated.

Syntax

• C#
• VB.NET

public event OnTLSCertValidateHandler OnTLSCertValidate;

public delegate void OnTLSCertValidateHandler(object sender, FTPServerTLSCertValidateEventArgs e);

public class FTPServerTLSCertValidateEventArgs : EventArgs {
  public long ConnectionID { get; }
  public bool Accept { get; set; }
}

Public Event OnTLSCertValidate As OnTLSCertValidateHandler

Public Delegate Sub OnTLSCertValidateHandler(sender As Object, e As FTPServerTLSCertValidateEventArgs)

Public Class FTPServerTLSCertValidateEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property Accept As Boolean
End Class

Remarks

The component fires this event to notify the application of an authenticating client. Use the event handler to validate the certificate and pass your decision back to the server component via the Accept parameter.

TLSEstablished Event (FTPServer Component)

Reports the setup of a TLS session.

Syntax

• C#
• VB.NET

public event OnTLSEstablishedHandler OnTLSEstablished;

public delegate void OnTLSEstablishedHandler(object sender, FTPServerTLSEstablishedEventArgs e);

public class FTPServerTLSEstablishedEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnTLSEstablished As OnTLSEstablishedHandler

Public Delegate Sub OnTLSEstablishedHandler(sender As Object, e As FTPServerTLSEstablishedEventArgs)

Public Class FTPServerTLSEstablishedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

Subscribe to this event to be notified about the setup of a TLS connection by a connected client.

TLSHandshake Event (FTPServer Component)

Fires when a newly established client connection initiates a TLS handshake.

Syntax

• C#
• VB.NET

public event OnTLSHandshakeHandler OnTLSHandshake;

public delegate void OnTLSHandshakeHandler(object sender, FTPServerTLSHandshakeEventArgs e);

public class FTPServerTLSHandshakeEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string ServerName { get; }
  public bool Abort { get; set; }
}

Public Event OnTLSHandshake As OnTLSHandshakeHandler

Public Delegate Sub OnTLSHandshakeHandler(sender As Object, e As FTPServerTLSHandshakeEventArgs)

Public Class FTPServerTLSHandshakeEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property ServerName As String
  Public Property Abort As Boolean
End Class

Remarks

Use this event to get notified about the initiation of the TLS handshake by the remote client. The ServerName parameter specifies the requested host from the client hello message.

TLSPSK Event (FTPServer Component)

Requests a pre-shared key for TLS-PSK.

Syntax

• C#
• VB.NET

public event OnTLSPSKHandler OnTLSPSK;

public delegate void OnTLSPSKHandler(object sender, FTPServerTLSPSKEventArgs e);

public class FTPServerTLSPSKEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Identity { get; }
  public string PSK { get; set; }
  public string Ciphersuite { get; set; }
}

Public Event OnTLSPSK As OnTLSPSKHandler

Public Delegate Sub OnTLSPSKHandler(sender As Object, e As FTPServerTLSPSKEventArgs)

Public Class FTPServerTLSPSKEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Identity As String
  Public Property PSK As String
  Public Property Ciphersuite As String
End Class

Remarks

The component fires this event to report that a client has requested a TLS-PSK negotiation. ConnectionId indicates the unique connection ID that requested the PSK handshake.

Use Identity to look up for the corresponding pre-shared key in the server's database, then assign the key to the PSK parameter. If TLS 1.3 PSK is used, you will also need to assign the Ciphersuite parameter with the cipher suite associated with that identity and their key.

TLSShutdown Event (FTPServer Component)

Reports closure of a TLS session.

Syntax

• C#
• VB.NET

public event OnTLSShutdownHandler OnTLSShutdown;

public delegate void OnTLSShutdownHandler(object sender, FTPServerTLSShutdownEventArgs e);

public class FTPServerTLSShutdownEventArgs : EventArgs {
  public long ConnectionID { get; }
}

Public Event OnTLSShutdown As OnTLSShutdownHandler

Public Delegate Sub OnTLSShutdownHandler(sender As Object, e As FTPServerTLSShutdownEventArgs)

Public Class FTPServerTLSShutdownEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
End Class

Remarks

The component fires this event when a connected client closes their TLS session gracefully. This event is typically followed by a Disconnect, which marks the closure of the underlying TCP session.

TransferCompleted Event (FTPServer Component)

This event is fired when a customized upload or download operation completes.

Syntax

• C#
• VB.NET

public event OnTransferCompletedHandler OnTransferCompleted;

public delegate void OnTransferCompletedHandler(object sender, FTPServerTransferCompletedEventArgs e);

public class FTPServerTransferCompletedEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int OperationStatus { get; set; }
}

Public Event OnTransferCompleted As OnTransferCompletedHandler

Public Delegate Sub OnTransferCompletedHandler(sender As Object, e As FTPServerTransferCompletedEventArgs)

Public Class FTPServerTransferCompletedEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property OperationStatus As Integer
End Class

Remarks

This event is fired when a customized transfer operation completes. This event is only fired for operations handled by the user code, i.e. those intercepted with BeforeUploadFile or BeforeDownloadFile event, and with Action parameter set to fraCustom.

The ConnectionID parameter specifies the session to which the event belongs, and OperationStatus reports the outcome of the transfer operation.

UploadBegin Event (FTPServer Component)

The server fires this event to notify the application about the start of a file upload operation.

Syntax

• C#
• VB.NET

public event OnUploadBeginHandler OnUploadBegin;

public delegate void OnUploadBeginHandler(object sender, FTPServerUploadBeginEventArgs e);

public class FTPServerUploadBeginEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
}

Public Event OnUploadBegin As OnUploadBeginHandler

Public Delegate Sub OnUploadBeginHandler(sender As Object, e As FTPServerUploadBeginEventArgs)

Public Class FTPServerUploadBeginEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
End Class

Remarks

Use this event to get notified about the beginning of a file upload operation. The file that is about to be uploaded is specified via the Path property.

UploadEnd Event (FTPServer Component)

Reports the completion of the upload operation.

Syntax

• C#
• VB.NET

public event OnUploadEndHandler OnUploadEnd;

public delegate void OnUploadEndHandler(object sender, FTPServerUploadEndEventArgs e);

public class FTPServerUploadEndEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
}

Public Event OnUploadEnd As OnUploadEndHandler

Public Delegate Sub OnUploadEndHandler(sender As Object, e As FTPServerUploadEndEventArgs)

Public Class FTPServerUploadEndEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
End Class

Remarks

Use this event to receive notifications about completion of file upload operations.

UploadFile Event (FTPServer Component)

An override for a file upload initiation operation.

Syntax

• C#
• VB.NET

public event OnUploadFileHandler OnUploadFile;

public delegate void OnUploadFileHandler(object sender, FTPServerUploadFileEventArgs e);

public class FTPServerUploadFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public long RestartAt { get; }
  public bool Append { get; }
  public int OperationStatus { get; set; }
}

Public Event OnUploadFile As OnUploadFileHandler

Public Delegate Sub OnUploadFileHandler(sender As Object, e As FTPServerUploadFileEventArgs)

Public Class FTPServerUploadFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property RestartAt As Long
  Public ReadOnly Property Append As Boolean
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event to let the application perform an overridden file upload initiation operation.

This event only fires if Action = fraCustom was passed back from BeforeUploadFile event, and expects your code to perform the requested operation inside the handler. No default operation will be performed by the server component.

Use the OperationStatus parameter to return the operation result back to the server.

This event will be followed by a number of WriteFile calls, passing the file data to your code, followed by a single TransferCompleted call.

Set OperationStatus to one of the following values:

UploadProgress Event (FTPServer Component)

Reports the progress of an active upload operation.

Syntax

• C#
• VB.NET

public event OnUploadProgressHandler OnUploadProgress;

public delegate void OnUploadProgressHandler(object sender, FTPServerUploadProgressEventArgs e);

public class FTPServerUploadProgressEventArgs : EventArgs {
  public long ConnectionID { get; }
  public string Path { get; }
  public long Progress { get; }
  public long Total { get; }
}

Public Event OnUploadProgress As OnUploadProgressHandler

Public Delegate Sub OnUploadProgressHandler(sender As Object, e As FTPServerUploadProgressEventArgs)

Public Class FTPServerUploadProgressEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public ReadOnly Property Path As String
  Public ReadOnly Property Progress As Long
  Public ReadOnly Property Total As Long
End Class

Remarks

Subscribe to this event to be notified about the progress of an active upload operation.

The Path parameter specifies the path to the file being uploaded, and Progress and Total reflect the operation progress. The Total parameter may be set to -1 if the size of the uploaded file is not known.

WriteFile Event (FTPServer Component)

Hands a piece of file data to the application.

Syntax

• C#
• VB.NET

public event OnWriteFileHandler OnWriteFile;

public delegate void OnWriteFileHandler(object sender, FTPServerWriteFileEventArgs e);

public class FTPServerWriteFileEventArgs : EventArgs {
  public long ConnectionID { get; }
  public int OperationStatus { get; set; }
}

Public Event OnWriteFile As OnWriteFileHandler

Public Delegate Sub OnWriteFileHandler(sender As Object, e As FTPServerWriteFileEventArgs)

Public Class FTPServerWriteFileEventArgs Inherits EventArgs
  Public ReadOnly Property ConnectionID As Long
  Public Property OperationStatus As Integer
End Class

Remarks

The component fires this event repeatedly during an overridden upload operation to pass file data to the application.

The handler of this event should retrieve the pending data buffer with a GetClientBuffer call, and write it to the end of the file that is being uploaded.

Use the OperationStatus parameter to return the operation result back to the server.

Set OperationStatus to one of the following values:

Certificate Type

Encapsulates an individual X.509 certificate.

Remarks

This type keeps and provides access to X.509 certificate details.

Fields