SynchronizeDownloadAsync(String,String,Boolean,Object) Method

Transfer files that do not exist locally asynchronously OR Files that have a different byte count OR Files that have a modification date difference in seconds greater than 60. The hour difference between the local machine and the SSH server is taken into account when CalcHourDifference has been called. By default all files and sub directories are attempted to be synchronized.

Syntax

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

'Declaration
 
Public Overloads Sub SynchronizeDownloadAsync( _
   ByVal localDirectory As System.String, _
   ByVal ftpDirectory As System.String, _
   ByVal subDirectories As System.Boolean, _
   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 customObject As System.Object
 
instance.SynchronizeDownloadAsync(localDirectory, ftpDirectory, subDirectories, customObject)

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

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

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

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

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

Parameters

localDirectory: The local path to put the directory
ftpDirectory: The FTP directory to download
subDirectories: If true, download subdirectories
customObject: Your custom object to be returned with Started, Progress, and Completed Events

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
 
//Only synchronize files in the specified directory, do not do sub directories
sftp.SynchronizeDownload("TestDir", "C:\\Download", false);
 
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
 
'Only synchronize files in the specified directory, do not do sub directories
sftp.SynchronizeDownload("TestDir", "C:\\Download", False)
 
Do While sftp.IsBusy = True
    System.Threading.Thread.Sleep(100)
Loop
 
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

Reference

SFTP Class
SFTP Members
Overload List