NET SFTP Library
DownloadDirectoryAsync(String,String) Method
Example 






KellermanSoftware.NetSFtpLibrary Namespace > SFTP Class > DownloadDirectoryAsync Method : DownloadDirectoryAsync(String,String) Method
The local path to put the directory
The FTP directory to download
Download an entire directory, subdirectories, and files asynchronously using sftp.
Syntax
'Declaration
 
Public Overloads Sub DownloadDirectoryAsync( _
   ByVal localDirectory As System.String, _
   ByVal ftpDirectory As System.String _
) 
'Usage
 
Dim instance As SFTP
Dim localDirectory As System.String
Dim ftpDirectory As System.String
 
instance.DownloadDirectoryAsync(localDirectory, ftpDirectory)
public void DownloadDirectoryAsync( 
   System.string localDirectory,
   System.string ftpDirectory
)
public procedure DownloadDirectoryAsync( 
    localDirectory: System.String;
    ftpDirectory: System.String
); 
public function DownloadDirectoryAsync( 
   localDirectory : System.String,
   ftpDirectory : System.String
);
public: void DownloadDirectoryAsync( 
   System.string* localDirectory,
   System.string* ftpDirectory
) 
public:
void DownloadDirectoryAsync( 
   System.String^ localDirectory,
   System.String^ ftpDirectory
) 

Parameters

localDirectory
The local path to put the directory
ftpDirectory
The FTP directory to download
Example
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
 
//Download an entire directory, subdirectories, 
// and files asynchronously using FTP 
sftp.DownloadDirectory("C:\\Download", "TestDir");
 
while (sftp.IsBusy == true)
{
    System.Threading.Thread.Sleep(100);
}
 
System.Console.WriteLine("TestDir has been downloaded");
System.Console.WriteLine("{0} files have been Transferred", sftp.FileCount);
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
 
'Download an entire directory, subdirectories, 
' and files asynchronously using FTP 
sftp.DownloadDirectory("C:\\Download", "TestDir")
 
Do While sftp.IsBusy = True
    System.Threading.Thread.Sleep(100)
Loop
 
System.Console.WriteLine("TestDir has been downloaded")
System.Console.WriteLine("{0} files have been Transferred", sftp.FileCount)
Requirements

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

See Also

Reference

SFTP Class
SFTP Members
Overload List