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 SFTP
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#

SFTP sftp = new SFTP(); //Trial Mode            
//SFTP sftp = new SFTP("place user name here", "place license key here");
 
// set the name of the SSH server( its URL )
sftp.HostAddress = "some.sftp.server.com"; // replace with your SFTP server
sftp.UserName  = "anonymous"; // replace with your user name
sftp.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
sftp.DownloadDirectory("TestDir", "C:\\Download");
/* sftp.DownloadDirectory("TestDir", "C:\\Download", true, "*.*");
 sftp.DownloadDirectory("TestDir", "C:\\Download", true, new Regex(".+"));
 sftp.DownloadDirectory("TestDir", "C:\\Download", true, DateTime.MinValue, DateTime.MaxValue);
 sftp.DownloadDirectory("TestDir", "C:\\Download", true, 0, Int64.MaxValue);
  */
 
while (sftp.IsBusy == true)
{
    System.Threading.Thread.Sleep(100);
}
 
System.Console.WriteLine("{0} files have been Transferred", sftp.FileCount);

Visual Basic

Dim sftp As SFTP = New SFTP() 'Trial Mode
'Dim sftp As SFTP = New SFTP("place user name here", "place license key here");
 
' set the name of the SSH server( its URL )
sftp.HostAddress = "some.sftp.server.com" ' replace with your SFTP server
sftp.UserName  = "anonymous" ' replace with your user name
sftp.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
sftp.DownloadDirectory("TestDir", "C:\\Download")
' sftp.DownloadDirectory("TestDir", "C:\\Download", true, "*.*");
 'sftp.DownloadDirectory("TestDir", "C:\\Download", true, new Regex(".+"));
 'sftp.DownloadDirectory("TestDir", "C:\\Download", true, DateTime.MinValue, DateTime.MaxValue);
 'sftp.DownloadDirectory("TestDir", "C:\\Download", true, 0, Int64.MaxValue);
  '
 
Do While sftp.IsBusy = True
    System.Threading.Thread.Sleep(100)
Loop
 
System.Console.WriteLine("{0} files have been Transferred", sftp.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

SFTP Class
SFTP Members
Overload List