Xceed .NET Libraries Documentation
How to copy items from an FTP server to a zip file on another FTP server

Welcome to Xceed .NET, .NET Standard and Xamarin Libraries! > Task-Based Help > FTP capabilities > Working with classes from the Xceed.FileSystem namespace > How to copy items from an FTP server to a zip file on another FTP server

Items can be copied or moved from one location to another using the CopyTo, CopyFilesTo, MoveTo, or MoveFilesTo methods. Both the source location/items can be located on an FTP server or any other type of folder supported by the Xceed FileSystem including zip files located on FTP servers. 

The following example demonstrates how to copy files located in a folder on an FTP server to a zip file located on another FTP server using the steps listed below:

  1. Create an instance of the FtpConnection class to establish a connection between the client and the source 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; see the Events section below for an example of this.
  2. Create an instance of the FtpConnection class to establish a connection between the client and the destination 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; see the Events section below for an example of this.
  3. Create an instance of an FtpFolder which will represent the folder on the source FTP server from which to retrieve the files. If a folder name is not specified, the folder will represent the current working folder. 
  4. Create an instance of a ZipArchive that will represent a new or existing zip file located on the destination FTP server. The files from the source FTP server will be copied directly into the zip file. 
  5. Call the FtpFolder's CopyFilesTo method to copy the files from the source FTP server to the zip file. 
  6. Dispose of the FtpConnections once the file transfer is completed by calling their Dispose methods or, in C#, by creating the FtpConnections instances in using blocks. 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
Imports Xceed.Zip


Dim sourceFTP As FtpConnection
Dim destinationFTP As FtpConnection

Try
  sourceFTP = New FtpConnection( "ftp.cdrom.com" )

  destinationFTP = New FtpConnection( "ftp.server.com" )

Dim sourceFolder As New FtpFolder(sourceFTP, "pub\simtelnet")
Dim zip As New ZipArchive(New FtpFile(destinationFTP, "simtelnet.zip"))

  sourceFolder.CopyFilesTo( zip, False, True )

Finally
  destinationFtp.Dispose()
  sourceFtp.Dispose()
End Try

C# Copy Code
using Xceed.FileSystem;
using Xceed.Ftp;
using Xceed.Zip;
 
using( FtpConnection sourceFTP = new FtpConnection( "ftp.cdrom.com" ) )
{
  FtpFolder sourceFolder = new FtpFolder( sourceFTP, "pub\\simtelnet" );        
 
  using( FtpConnection destinationFTP = new FtpConnection( "ftp.server.com" ) )
  {
    ZipArchive zip = new ZipArchive( new FtpFile( destinationFTP, "simtelnet.zip" ) );
    sourceFolder.CopyFilesTo( zip, false, 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.

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
Imports Xceed.Zip

Dim sourceFTP As FtpConnection
Dim destinationFTP As FtpConnection

Dim events As FileSystemEvents

Try
  sourceFTP = New FtpConnection( "ftp.cdrom.com" )
  destinationFTP = New FtpConnection( "ftp.server.com" )

  events = FileSystemEvents()
  AddHandler events.ByteProgression, AddressOf Me.byte_progression
  AddHandler events.ScanningFolder, AddressOf Me.scanning_folder

  Dim sourceFolder As New FtpFolder( sourceFTP, "pub\simtelnet" )
  Dim zip As New ZipArchive( New FtpFile( destinationFTP, "simtelnet.zip" ) )

  sourceFolder.CopyFilesTo( events, Nothing, zip, False, True )
Finally
  destinationFtp.Dispose()
  sourceFtp.Dispose()

  RemoveHandler events.ByteProgression, AddressOf Me.byte_progression
  RemoveHandler events.ScanningFolder, AddressOf Me.scanning_folder
End Try

Private Sub byte_progression( ByVal sender As Object, ByVal e As ByteProgressionEventArgs )
  System.Diagnostics.Debug.WriteLine( e.AllFilesBytes.Processed.ToString() )
  Application.DoEvents()
End Sub

Private Sub scanning_folder( ByVal sender As Object, ByVal e As ScanningFolderEventArgs )
  System.Diagnostics.Debug.WriteLine( "Scanning " & e.CurrentItem.Name )
End Sub                   
C# Copy Code

using Xceed.FileSystem;
using Xceed.Ftp;
using Xceed.Zip;

FileSystemEvents events = new FileSystemEvents();
events.ByteProgression += new ByteProgressionEventHandler( this.byte_progression );
events.ScanningFolder += new ScanningFolderEventHandler( this.scanning_folder );

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

   FtpFolder sourceFolder = new FtpFolder( sourceFTP, "pub\\simtelnet" );          

   using( FtpConnection destinationFTP = new FtpConnection( "ftp.server.com" ) )
   {
    ZipArchive zip = new ZipArchive( new FtpFile( destinationFTP, "simtelnet.zip" ) );
    sourceFolder.CopyFilesTo( events, null, zip, false, true );         
  }
}

events.ByteProgression -= new ByteProgressionEventHandler( this.byte_progression );
events.ScanningFolder -= new ScanningFolderEventHandler( this.scanning_folder );

private void byte_progression( object sender, ByteProgressionEventArgs e )
{
  System.Diagnostics.Debug.WriteLine( e.AllFilesBytes.Processed.ToString() );
  Application.DoEvents();
}

private void scanning_folder( object sender, ScanningFolderEventArgs e )
{
  System.Diagnostics.Debug.WriteLine( "Scanning " + e.CurrentItem.Name );
}                   

Things to consider

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

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

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

  • Do you want to filter (specify specific files and folders) the items that are to be copied? Use filters. 

  • Do you want to display progress information? Create an instance of the FileSystemEvents class and handle the ByteProgression and/or ItemProgression events. 

  • Do you want to display progress information when a folder is being scanned? Create an instance of the FileSystemEvents class and handle the ScanningFolder event. 

  • Do you want to intervene when an error occurs with one or more of the items being manipulated? Create an instance of the FileSystemEvents class and handle the ItemException event. 

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

  • Do you want quick and easy access to FTP functionalities in the same style as the ActiveX version of the Xceed FTP Library? Use the FtpClient class instead. (Note: The AsyncFtpClient should now be considered obsolete. Instead, use the FtpClient class, assigning a value to its SynchronizingObject property.)

 

 

Copyright Xceed Software Inc

Send Feedback