Xceed .NET Libraries Documentation
How to copy items to an FTP server

Welcome to Xceed .NET, .NET Standard and Xamarin Libraries! > Basic Concepts > FTP capabilities > FTP using the FileSystem interface > How to copy items to an FTP server

Items can be copied or moved (in other words, uploaded) from a local drive (or any other type of folder supported by the Xceed FileSystem) to an FTP server using the CopyTo, CopyFilesTo, MoveTo, or MoveFilesTo methods. 

The following example demonstrates how to copy files from a local folder to an FTP server using the steps listed below:

  1. Create an instance of the FtpConnection class to establish a connection between the client and the FTP server. If you are using FtpConnection in a UI application, assign your form (or any other control that implements the ISynchronizeInvoke interface) to the SynchronizingObject property and call Application.DoEvents in an event such as ByteProgression; see the Events section below for an example of this.

  2. Create an instance of a DiskFolder which will representing the local folder from where the files will be uploaded. Any other implementation of the AbstractFolder class, such as the MemoryFolder class which represents a folder located in memory, can also be used as the source folder. 

  3. Create an instance of an FtpFolder which will represent the folder on the FTP server to where the files will be uploaded. If a folder name is not specified, the folder will represent the current working folder. 

  4. Call the DiskFolder's CopyFilesTo method to copy the files to the FTP server. 

  5. Dispose of the FtpConnection once the file transfer is completed by calling its Dispose method or, in C#, by creating the FtpConnection instance in a using block. If an instance of an FtpConnection object is not disposed of, connections with the FTP server may remain active until the FTP server times-out or the garbage-collector passes.

VB.NET Copy Code

Imports Xceed.FileSystem
Imports Xceed.Ftp

Dim connection As FtpConnection

Try
  connection = New FtpConnection( "ftp.server.com" )

  Dim source As New DiskFolder( "d:\test" )
  Dim destination As New FtpFolder( connection, source.Name )

  source.CopyFilesTo( destination, True, True )
Finally
  connection.Dispose()
End Try

C# Copy Code

using Xceed.FileSystem;
using Xceed.Ftp;

using( FtpConnection connection = new FtpConnection( "ftp.server.com" ) )
{
  DiskFolder source = new DiskFolder( "d:\\test" );
  FtpFolder destination = new FtpFolder( connection, source.Name );
 
  source.CopyFilesTo( destination, true, true );        
}

Events

All methods exposed by the Xceed FileSystem's FileSystemItem, AbstractFolder, AbstractFile, and derived classes have an overload that can be used when events are required. 

If you are using FtpConnection in a UI application, assign your form (or any other control that implements the ISynchronizeInvoke interface) to the SynchronizingObject property and call Application.DoEvents in an event such as ByteProgression.

With the exception of the FtpConnection's ParsingListingLine event, events can be handled by creating an instance of the FileSystemEvents class and subscribing to the desired events. For example:

VB.NET Copy Code

Imports Xceed.FileSystem
Imports Xceed.Ftp

Dim connection As FtpConnection
Dim events As FileSystemEvents

Try
  connection = New FtpConnection( "ftp.server.com" )
  'When using FtpConnection in a UI application
  connection.SynchronizingObject = Me

  events = New FileSystemEvents()
  AddHandler events.ItemProgression, AddressOf Me.item_progression
  AddHandler events.ByteProgression, AddressOf Me.byte_progression

  Dim source As New DiskFolder( "d:\test" )
  Dim destination As New FtpFolder( connection, source.Name )

  source.CopyFilesTo( events, Nothing, destination, True, True )

Finally
  connection.Dispose()
  RemoveHandler events.ItemProgression, AddressOf Me.item_progression
  RemoveHandler events.ByteProgression, AddressOf Me.byte_progression
End Try

Private Sub item_progression( ByVal sender As Object, ByVal e As ItemProgressionEventArgs )
  System.Diagnostics.Debug.WriteLine( e.CurrentItem.Name )
End Sub

Private Sub byte_progression( ByVal sender As Object, ByVal e As ByteProgressionEventArgs )
  Application.DoEvents()
End Sub

C# Copy Code

using Xceed.FileSystem;
using Xceed.Ftp;

using( FtpConnection connection = new FtpConnection( "ftp.server.com" ) )
{
  //When using FtpConnection in a UI application
  connection.SynchronizingObject = this;

  DiskFolder source = new DiskFolder( "d:\\test" );
  FtpFolder destination = new FtpFolder( connection, source.Name );

  FileSystemEvents events = new FileSystemEvents();
  events.ItemProgression += new ItemProgressionEventHandler( this.item_progression );
  events.ByteProgression += new ByteProgressionEventHandler( this.byte_progression );

  source.CopyFilesTo( events, null, destination, true, true );        
  events.ItemProgression -= new ItemProgressionEventHandler( this.item_progression );
  events.ByteProgression -= new ByteProgressionEventHandler( this.byte_progression );
}

private void item_progression( object sender, ItemProgressionEventArgs e )
{
  System.Diagnostics.Debug.WriteLine( e.CurrentItem.Name );
}

private void byte_progression( object sender, ByteProgressionEventArgs e )
{
  Application.DoEvents();
}

Things to consider

 

 

Copyright Xceed Software Inc

Send Feedback