FtpPreprocessParameters Class

 

Defines the information for FTP activity before a command has completed, such as user name, session ID, IP addresses for the client and server, etc. Developers can select which information to use when implementing the IFtpPreprocessProvider Interface.

Syntax

public sealed class FtpPreprocessParameters
{
   public Filetime SessionStartTime;
   public long BytesReceivedPerSession;
   public long BytesSentPerSession;
   public string Command;
   public string CommandParameters;
   public string HostName;
   public string LocalIPAddress;
   public int LocalIPPort;
   public string RemoteIPAddress;
   public int RemoteIPPort;
   public string SessionId;
   public string SiteName;
   public string UserName;
}
Public NotInheritable Class FtpPreprocessParameters
    Public SessionStartTime As Filetime
    Public BytesReceivedPerSession As Long
    Public BytesSentPerSession As Long
    Public Command As String
    Public CommandParameters As String
    Public HostName As String
    Public LocalIPAddress As String
    Public LocalIPPort As Integer
    Public RemoteIPAddress As String
    Public RemoteIPPort As Integer
    Public SessionId As String
    Public SiteName As String
    Public UserName As String
End Class

Members

Member Name Definition
SessionStartTime The start time for the current session.
BytesReceivedPerSession The number of bytes received from the client during the current session.
BytesSentPerSession The number of bytes sent to the client during the current session.
Command The FTP command.
CommandParameters The parameters related to the FTP command.
HostName The FTP virtual host name.
LocalIPAddress The local IP address the client is connected to.
LocalIPPort The TCP/IP port of the server.
RemoteIPAddress The IP address of the client.
RemoteIPPort The TCP/IP port of the client.
SessionId The session ID.
SiteName The name of the server instance that is being logged.
UserName The name of the user.

Example

For an example, see How to Use Managed Code (C#) to Create an FTP Provider that Prevents Leeching.

Requirements

Type Description
Client - IIS 8.0 on Windows 8
- IIS 10.0 on Windows 10
Server - IIS 8.0 on Windows Server 2012
- IIS 8.5 on Windows Server 2012 R2
- IIS 10.0 on Windows Server 2016 Technical Preview
Product - IIS 8.0, IIS 8.5, IIS 10.0
Reference Microsoft.Web.FtpServer.dll

See Also

IFtpPostprocessProvider Interface

IFtpPreprocessProvider Interface

FtpPostprocessParameters Class