Xceed Logo
Shop
Xceed .NET Libraries Documentation
Welcome to Xceed Data Manipulation Compoents for .NET and .NET Standard / Task-Based Help / FTP capabilities / Working with the FtpClient interface / How to receive files

In This Topic
    How to receive files
    In This Topic

    The ReceiveFile and ReceiveMultipleFiles methods of the FtpClient class as well as the BeginReceiveFile/ EndReceiveFile and BeginReceiveMultipleFiles/ EndReceiveMultipleFiles methods of the AsyncFtpClient class are used to receive one or more files from an FTP server. 

    The ReceiveFile and BeginReceiveFile/EndReceiveFile methods receive one file from an FTP server while the ReceiveMultipleFiles and BeginReceiveMultipleFiles/EndReceiveMultipleFiles methods receive one or more files. 

    AsyncFtpClient's methods now call the corresponding synchronous methods on a background thread. For this reason, the AsyncFtpClient class is now considered obsolete. It is therefore recommended to use FtpClient instead to improve code readability.
    When using Xceed FTP for .NET in a WinForms application, it is recommended that a SynchronizingObject be assigned to the SynchronizingObject property of the FtpClient class. For more information, jump to the WinForms applications and threading topic. 

    All the methods above receive the files from the FTP server's current working directory. If you want to receive the files from another location, you could use the ChangeCurrentFolder or BeginChangeCurrentFolder/ EndChangeCurrentFolder, or ChangeToParentFolder or BeginChangeToParentFolder/ EndChangeToParentFolder methods to change the current working folder. The current working folder can be retrieved via the GetCurrentFolder or BeginGetCurrentFolder/ EndGetCurrentFolder methods.

    Synchronous (blocking) and asynchronous (non-blocking) demonstration using FtpClient

    The following example demonstrates how to receive a file from an FTP server using the ReceiveFile method and provide logging information during the process using the CommandSent and ReplyReceived events. An asynchronous (non-blocking) demonstration is also available.

    VB.NET Copy Code

    Imports Xceed.Ftp

    ' When using FtpClient, you can instruct
    ' the library to automatically redirect events on the main UI thread
    ' by setting the SynchronizingObject property.
    ftp.SynchronizingObject = Me

    Dim ftp As New FtpClient()

    AddHandler ftp.CommandSent, AddressOf Me.FTP_CommandSent
    AddHandler ftp.ReplyReceived, AddressOf Me.FTP_ReplyReceived

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

    ftp.ReceiveFile( "test.txt", "d:\new_text.txt" )

    ftp.Disconnect()

    RemoveHandler ftp.CommandSent, AddressOf Me.FTP_CommandSent
    RemoveHandler ftp.ReplyReceived, AddressOf Me.FTP_ReplyReceived

    Private Sub FTP_CommandSent(ByVal sender As Object, ByVal e As CommandSentEventArgs)
      ListBox1.Items.Add(">> " + e.Command)
    End Sub

    Private Sub FTP_ReplyReceived(ByVal sender As Object, ByVal e As ReplyReceivedEventArgs)
      ListBox1.Items.Add("<< " + e.Reply.ToString())
    End Sub

    C# Copy Code
    using Xceed.Ftp;
     
    FtpClient ftp = new FtpClient();
          
    // When using FtpClient, you can instruct
    // the library to automatically redirect events on the main UI thread
    // by setting the SynchronizingObject property.
    ftp.SynchronizingObject = this;

    ftp.CommandSent += new CommandSentEventHandler( this.FTP_CommandSent );
    ftp.ReplyReceived += new ReplyReceivedEventHandler( this.FTP_ReplyReceived );
     
    ftp.Connect( "localhost" );
    ftp.Login();
     
    ftp.ReceiveFile( "test.txt", @"d:\new_text.txt" );
     
    ftp.Disconnect();
     
    ftp.CommandSent -= new CommandSentEventHandler( this.FTP_CommandSent );
    ftp.ReplyReceived -= new ReplyReceivedEventHandler( this.FTP_ReplyReceived );
     
    private void FTP_CommandSent( object sender, CommandSentEventArgs e )
    {
      listBox1.Items.Add( ">> " + e.Command );
    }
     
    private void FTP_ReplyReceived( object sender, ReplyReceivedEventArgs e )
    {
      listBox1.Items.Add( "<< " + e.Reply.ToString() );
    }

    Asynchronous (non-blocking) demonstration

    The following example demonstrates how to receive a file from an FTP server using the BeginReceiveFile/ EndReceiveFile methods and provide logging information during the process using the CommandSent and ReplyReceived events.  A synchronous (non-blocking) demonstration is also available. 

    To clarify the code, instead of using callbacks, we will wait for completion of the operation before calling the matching "End" method. More information is available in the WinForms application and threading topic.

    VB.NET Copy Code

    Imports Xceed.Ftp

    Dim ftp As New AsyncFtpClient()

    AddHandler ftp.CommandSent, AddressOf Me.FTP_CommandSent
    AddHandler ftp.ReplyReceived, AddressOf Me.FTP_ReplyReceived

    Dim result As IAsyncResult = ftp.BeginConnect("localhost", Nothing, Nothing)

    While Not result.IsCompleted
      Application.DoEvents()
    End While

    ftp.EndConnect( result )
    result = ftp.BeginLogin( Nothing, Nothing )

    While Not result.IsCompleted
      Application.DoEvents()
    End While

    ftp.EndLogin( result )
    result = ftp.BeginReceiveFile( "test.txt", "d:\new_text.txt", Nothing, Nothing )

    While Not result.IsCompleted
      Application.DoEvents()
    End While

    ftp.EndReceiveFile( result )
    result = ftp.BeginDisconnect( Nothing, Nothing )

    While Not result.IsCompleted
      Application.DoEvents()
    End While

    ftp.EndDisconnect( result )

    RemoveHandler ftp.CommandSent, AddressOf Me.FTP_CommandSent
    RemoveHandler ftp.ReplyReceived, AddressOf Me.FTP_ReplyReceived

    Private Sub FTP_CommandSent(ByVal sender As Object, ByVal e As CommandSentEventArgs)
      ListBox1.Items.Add(">> " + e.Command)
    End Sub

    Private Sub FTP_ReplyReceived(ByVal sender As Object, ByVal e As ReplyReceivedEventArgs)
      ListBox1.Items.Add("<< " + e.Reply.ToString())
    End Sub

    C# Copy Code
    using Xceed.Ftp;
     
    AsyncFtpClient ftp = new AsyncFtpClient();
          
    ftp.CommandSent += new CommandSentEventHandler( this.FTP_CommandSent );
    ftp.ReplyReceived += new ReplyReceivedEventHandler( this.FTP_ReplyReceived );
     
    IAsyncResult result = ftp.BeginConnect( "localhost", null, null );
     
    while( !result.IsCompleted )
      Application.DoEvents();
     
    ftp.EndConnect( result );
    result = ftp.BeginLogin( null, null );
     
    while( !result.IsCompleted )
      Application.DoEvents();
     
    ftp.EndLogin( result );
    result = ftp.BeginReceiveFile( "test.txt", @"d:\new_text.txt", null, null );
     
    while( !result.IsCompleted )
      Application.DoEvents();
     
    ftp.EndReceiveFile( result );
    result = ftp.BeginDisconnect( null, null );
     
    while( !result.IsCompleted )
      Application.DoEvents();
     
    ftp.EndDisconnect( result );
     
    ftp.CommandSent -= new CommandSentEventHandler( this.FTP_CommandSent );
    ftp.ReplyReceived -= new ReplyReceivedEventHandler( this.FTP_ReplyReceived );
     
    private void FTP_CommandSent( object sender, CommandSentEventArgs e )
    {
      listBox1.Items.Add( ">> " + e.Command );
    }
     
    private void FTP_ReplyReceived( object sender, ReplyReceivedEventArgs e )
    {
      listBox1.Items.Add( "<< " + e.Reply.ToString() );
    }

    Things you should consider

    • Are you using Xceed FTP for .NET in a WinForms application? Use the AsyncFtpClient class rather than the FtpClient class. 

    • Do you want the FTP server to initiate the data connection rather than the FTP client? Set the PassiveTransfer property to false. 

    • Do you want the file(s) to be received in ASCII mode rather than binary? Set the RepresentationType property to ASCII. 

    • Do you want to decrease or increase the period of time after which an FTP operation should timeout? Change the value of the Timeout property. 

    • Do you want to create a log file of the FTP process? Set the TraceWriter property. 

    • Do you want to know the state of the FTP client? Check the Connected and Busy properties. You can also check the State property for specific state information. The StateChanged event can also be used to know when the state of the FTP client changes. 

    • Do you want to know when a file is being received? Handle the ReceivingFile event. 

    • Do you want to display progress information? Handle the FileTransferStatus event. 

    • Do you want to continue a multiple-file transfer (when using the ReceiveMultipleFiles method) when one or more of the files being transferred causes an error? Handle the MultipleFileTransferError event. 

    • Do you want to abort the FTP operation? Call the Abort method. 

    • Do you want to prevent routers from prematurely closing the command channel while a long data transfer is taking place. Set the KeepAliveInterval property.

     

     

    Copyright Xceed Software Inc

    Send Feedback