ReceivingFile Event

In This Topic

Raised for each file being received from the FTP server.

Syntax

Visual Basic
C#

'Declaration
 
Public Event ReceivingFile As TransferringFileEventHandler

'Usage
 
Dim instance As FtpClient
Dim handler As TransferringFileEventHandler
 
AddHandler instance.ReceivingFile, handler

public event TransferringFileEventHandler ReceivingFile

Event Data

The event handler receives an argument of type TransferringFileEventArgs containing data related to this event. The following TransferringFileEventArgs properties provide information specific to this event.

Property	Description
LocalFilename	Gets the path and filename of the local file.
RemoteFilename	Gets the filename of the remote file.

Remarks

When using overloads of the ReceiveFile method that take a System.IO.Stream as a parameter, the value of the TransferringFileEventArgs.LocalFilename property will be System.String.Empty.

Example

The following example demonstrates how to use the ReceivingFile event to display the name of the file(s) being received from the FTP server. This example assumes that you are in a Windows application and that the form contains a listbox.

VB.NET
C#

Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX" ' Set license key here to deploy 

Dim ftp As New FtpClient()

AddHandler ftp.ReceivingFile, AddressOf Me.receiving_file

ftp.Connect( "localhost" )
ftp.Login()

ftp.ReceiveMultipleFiles( "ClientFiles\*", "d:\", True, True )

ftp.Disconnect()

Private Sub receiving_file( ByVal sender As object, ByVal e As TransferringFileEventArgs )

  listBox1.Items.Add( "RECEIVING " + e.RemoteFilename.ToUpper() + " TO " + e.LocalFilename.ToUpper() )
  listBox1.Refresh()
End Sub

Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX" // Set license key here to deploy 

FtpClient ftp = new FtpClient();

ftp.ReceivingFile += new TransferringFileEventHandler( this.receiving_file );

ftp.Connect( "localhost" );
ftp.Login();

ftp.ReceiveMultipleFiles( @"ClientFiles\*", @"d:\", true, true );

ftp.Disconnect();

private void receiving_file( object sender, TransferringFileEventArgs e )
{
  listBox1.Items.Add( "RECEIVING " + e.RemoteFilename.ToUpper() + " TO " + e.LocalFilename.ToUpper() );
  listBox1.Refresh();      
}

Example

Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX" ' Set license key here to deploy Dim ftp As New FtpClient() AddHandler ftp.ReceivingFile, AddressOf Me.receiving_file ftp.Connect( "localhost" ) ftp.Login() ftp.ReceiveMultipleFiles( "ClientFiles\*", "d:\", True, True ) ftp.Disconnect() Private Sub receiving_file( ByVal sender As object, ByVal e As TransferringFileEventArgs ) listBox1.Items.Add( "RECEIVING " + e.RemoteFilename.ToUpper() + " TO " + e.LocalFilename.ToUpper() ) listBox1.Refresh() End Sub
Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX" // Set license key here to deploy FtpClient ftp = new FtpClient(); ftp.ReceivingFile += new TransferringFileEventHandler( this.receiving_file ); ftp.Connect( "localhost" ); ftp.Login(); ftp.ReceiveMultipleFiles( @"ClientFiles\*", @"d:\", true, true ); ftp.Disconnect(); private void receiving_file( object sender, TransferringFileEventArgs e ) { listBox1.Items.Add( "RECEIVING " + e.RemoteFilename.ToUpper() + " TO " + e.LocalFilename.ToUpper() ); listBox1.Refresh(); }

Supported Frameworks

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Standard: netstandard2.0, netstandard2.1

.NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

FtpClient Class
FtpClient Members
System.IO.Stream
LocalFilename Property
System.String.Empty

Send Feedback

Business Suite

Ultimate Suite

Reference