NET SFTP Library
DownloadDirectory(String,String) Method
Example 






KellermanSoftware.NetSFtpLibrary Namespace > SFTP Class > DownloadDirectory Method : DownloadDirectory(String,String) Method
The local path to put the directory
The FTP directory to download
Download an entire directory, subdirectories, and files synchronously using FTP
Syntax
'Declaration
 
Public Overloads Function DownloadDirectory( _
   ByVal localDirectory As System.String, _
   ByVal ftpDirectory As System.String _
) As System.Collections.Generic.List(Of TransferInfo)
'Usage
 
Dim instance As SFTP
Dim localDirectory As System.String
Dim ftpDirectory As System.String
Dim value As System.Collections.Generic.List(Of TransferInfo)
 
value = instance.DownloadDirectory(localDirectory, ftpDirectory)
public System.Collections.Generic.List<TransferInfo> DownloadDirectory( 
   System.string localDirectory,
   System.string ftpDirectory
)
public function DownloadDirectory( 
    localDirectory: System.String;
    ftpDirectory: System.String
): System.Collections.Generic.List; 
public function DownloadDirectory( 
   localDirectory : System.String,
   ftpDirectory : System.String
) : System.Collections.Generic.List;
public: System.Collections.Generic.List<TransferInfo*>* DownloadDirectory( 
   System.string* localDirectory,
   System.string* ftpDirectory
) 
public:
System.Collections.Generic.List<TransferInfo^>^ DownloadDirectory( 
   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 synchronously using FTP 
System.Console.WriteLine("We are downloading the TestDir folder.This is a blocking call");
sftp.DownloadDirectory("C:\\Download", "TestDir");
 
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 synchronously using FTP 
System.Console.WriteLine("We are downloading the TestDir folder.This is a blocking call")
sftp.DownloadDirectory("C:\\Download", "TestDir")
 
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