Items can be copied or moved (in other words, downloaded) from an FTP server to a local drive (or any other type of folder supported by the Xceed FileSystem) using the CopyTo, CopyFilesTo, MoveTo, or MoveFilesTo methods.
The following example demonstrates how to copy the content of a folder located on an FTP server to a local folder using the steps listed below:
-
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.
-
Create an instance of an FtpFolder which will represent the folder on the FTP server from which to retrieve the files. If a folder name is not specified, the folder will represent the current working folder.
-
Create an instance of a DiskFolder which will representing the local folder to where the files will be downloaded. 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 destination folder.
-
Call the FtpFolder's CopyFilesTo method to copy the content of the folder from the FTP server to the local destination.
-
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 |
|
Imports Xceed.FileSystem
Imports Xceed.Ftp
' If your trial period has expired, you must purchase a registered license key,
' uncomment the appropriate line of code below, and insert your registered license key.
' For more information, jump to the How the 45-day trial works and the
' How to license the component topics.
' For Xceed FTP for .NET:
'Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX"
' For Xceed FTP for .NET Compact Framework:
'Xceed.Ftp.Licenser.LicenseKey = "FTCXX-XXXXX-XXXXX-XXXX"
Dim connection As FtpConnection
Try
connection = New FtpConnection( "ftp.server.com" )
Dim source As New FtpFolder( connection )
Dim destination As New DiskFolder( "d:\ftp_download" )
source.CopyFilesTo( destination, False, True )
Finally
connection.Dispose()
End Try
|
| C# |
|
using Xceed.FileSystem;
using Xceed.Ftp;
// If your trial period has expired, you must purchase a registered license key,
// uncomment the appropriate line of code below, and insert your registered license key.
// For more information, jump to the How the 45-day trial works and the
// How to license the component topics.
// For Xceed FTP for .NET:
//Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX";
// For Xceed FTP for .NET Compact Framework:
//Xceed.Ftp.Licenser.LicenseKey = "FTCXX-XXXXX-XXXXX-XXXX";
using( FtpConnection connection = new FtpConnection( "ftp.server.com" ) )
{
FtpFolder source = new FtpFolder( connection );
DiskFolder destination = new DiskFolder( "d:\\ftp_download" );
source.CopyFilesTo( destination, 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 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 |
|
Imports Xceed.FileSystem
Imports Xceed.Ftp
' If your trial period has expired, you must purchase a registered license key,
' uncomment the appropriate line of code below, and insert your registered license key.
' For more information, jump to the How the 45-day trial works and the
' How to license the component topics.
' For Xceed FTP for .NET:
'Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX"
' For Xceed FTP for .NET Compact Framework:
'Xceed.Ftp.Licenser.LicenseKey = "FTCXX-XXXXX-XXXXX-XXXX"
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 FtpFolder( connection )
Dim destination As New DiskFolder( "d:\ftp_download" )
source.CopyFilesTo( events, Nothing, destination, False, True )
Finally
connection.Dispose()
RemoveHandler events.ItemProgression, AddressOf Me.item_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 ItemProgressionEventArgs )
Application.DoEvents()
End Sub
|
| C# |
|
using Xceed.FileSystem;
using Xceed.Ftp;
// If your trial period has expired, you must purchase a registered license key,
// uncomment the appropriate line of code below, and insert your registered license key.
// For more information, jump to the How the 45-day trial works and the
// How to license the component topics.
// For Xceed FTP for .NET:
//Xceed.Ftp.Licenser.LicenseKey = "FTNXX-XXXXX-XXXXX-XXXX";
// For Xceed FTP for .NET Compact Framework:
//Xceed.Ftp.Licenser.LicenseKey = "FTCXX-XXXXX-XXXXX-XXXX";
FileSystemEvents events = new FileSystemEvents();
events.ItemProgression += new ItemProgressionEventHandler( this.item_progression );
events.ByteProgression += new ByteProgressionEventHandler( this.byte_progression );
using( FtpConnection connection = new FtpConnection( "ftp.server.com" ) )
{
//When using FtpConnection in a UI application
connection.SynchronizingObject = this;
FtpFolder source = new FtpFolder( connection );
DiskFolder destination = new DiskFolder( "d:\\ftp_download" );
source.CopyFilesTo( events, null, destination, false, true );
}
events.ItemProgression -= new ItemProgressionEventHandler( this.item_progression );
private void item_progression( object sender, ItemProgressionEventArgs e )
{
System.Diagnostics.Debug.WriteLine( e.CurrentItem.Name );
}
private void byte_progression( object sender, ItemProgressionEventArgs e )
{
Application.DoEvents();
}
|
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.)