DownloadDirectoryAsync(String,String,Boolean,String,Object) Method

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Sub DownloadDirectoryAsync( _
   ByVal localDirectory As System.String, _
   ByVal ftpDirectory As System.String, _
   ByVal subDirectories As System.Boolean, _
   ByVal wildCardPattern As System.String, _
   ByVal customObject As System.Object _
)

'Usage
 
Dim instance As FTP
Dim localDirectory As System.String
Dim ftpDirectory As System.String
Dim subDirectories As System.Boolean
Dim wildCardPattern As System.String
Dim customObject As System.Object
 
instance.DownloadDirectoryAsync(localDirectory, ftpDirectory, subDirectories, wildCardPattern, customObject)

public void DownloadDirectoryAsync( 
   System.string localDirectory,
   System.string ftpDirectory,
   System.bool subDirectories,
   System.string wildCardPattern,
   System.object customObject
)

public procedure DownloadDirectoryAsync( 
    localDirectory: System.String;
    ftpDirectory: System.String;
    subDirectories: System.Boolean;
    wildCardPattern: System.String;
    customObject: System.TObject
);

public function DownloadDirectoryAsync( 
   localDirectory : System.String,
   ftpDirectory : System.String,
   subDirectories : System.boolean,
   wildCardPattern : System.String,
   customObject : System.Object
);

public: void DownloadDirectoryAsync( 
   System.string* localDirectory,
   System.string* ftpDirectory,
   System.bool subDirectories,
   System.string* wildCardPattern,
   System.Object* customObject
)

public:
void DownloadDirectoryAsync( 
   System.String^ localDirectory,
   System.String^ ftpDirectory,
   System.bool subDirectories,
   System.String^ wildCardPattern,
   System.Object^ customObject
)

Parameters

localDirectory: The local path to put the directory
ftpDirectory: The FTP directory to download
subDirectories: Download files in sub directories
wildCardPattern: Standard wildcard pattern
customObject: Your custom object to be returned with Started, Progress, and Completed Events

C#

FTP ftp = new FTP(); //Trial Mode            
//FTP ftp = new FTP("place user name here", "place license key here");
 
// set the name of the FTP server( its URL )
ftp.HostAddress = "ftp.fsz.bme.hu"; // a hungarian university. change this to your ftp server
ftp.UserName = "anonymous"; // replace with your user name
ftp.Password = "user@mail.com"; // replace with your password
 
//Downloads all directories, subdirectories and files in the selected Directory asynchronously from FTP 
System.Console.WriteLine("We are downloading the TestDir folder.This is a non-blocking call");
 
// All these calls do the same thing
ftp.DownloadDirectory("C:\\Download", "TestDir");
/* ftp.DownloadDirectory("C:\\Download", "TestDir", true, "*.*");
 ftp.DownloadDirectory("C:\\Download", "TestDir", true, new Regex(".+"));
 ftp.DownloadDirectory("C:\\Download", "TestDir", true, DateTime.MinValue, DateTime.MaxValue);
 ftp.DownloadDirectory("C:\\Download", "TestDir", true, 0, Int64.MaxValue);
  */
 
while (ftp.IsBusy == true)
{
    System.Threading.Thread.Sleep(100);
}
 
System.Console.WriteLine("{0} files have been Transferred", ftp.FileCount);

Visual Basic

Dim ftp As FTP = New FTP() 'Trial Mode
'FTP ftp = new FTP("place user name here", "place license key here");
 
' set the name of the FTP server( its URL )
ftp.HostAddress = "ftp.fsz.bme.hu" ' a hungarian university. change this to your ftp server
ftp.UserName = "anonymous" ' replace with your user name
ftp.Password = "user@mail.com" ' replace with your password
 
'Downloads all directories, subdirectories and files in the selected Directory asynchronously from FTP 
System.Console.WriteLine("We are downloading the TestDir folder.This is a non-blocking call")
 
' All these calls do the same thing
ftp.DownloadDirectory("C:\\Download", "TestDir")
' ftp.DownloadDirectory("C:\\Download", "TestDir", true, "*.*")
'ftp.DownloadDirectory("C:\\Download", "TestDir", true, new Regex(".+"))
'ftp.DownloadDirectory("C:\\Download", "TestDir", true, DateTime.MinValue, DateTime.MaxValue)
'ftp.DownloadDirectory("C:\\Download", "TestDir", true, 0, Int64.MaxValue)
'
 
Do While ftp.IsBusy = True
    System.Threading.Thread.Sleep(100)
Loop
 
System.Console.WriteLine("{0} files have been Transferred", ftp.FileCount)

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

FTP Class
FTP Members
Overload List