DownloadFileAsync(String,String,Int64,Object) Method

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

'Declaration
 
Public Overloads Sub DownloadFileAsync( _
   ByVal localFilePath As System.String, _
   ByVal ftpFileName As System.String, _
   ByVal restart As System.Long, _
   ByVal customObject As System.Object _
)

'Usage
 
Dim instance As SFTP
Dim localFilePath As System.String
Dim ftpFileName As System.String
Dim restart As System.Long
Dim customObject As System.Object
 
instance.DownloadFileAsync(localFilePath, ftpFileName, restart, customObject)

public void DownloadFileAsync( 
   System.string localFilePath,
   System.string ftpFileName,
   System.long restart,
   System.object customObject
)

public procedure DownloadFileAsync( 
    localFilePath: System.String;
    ftpFileName: System.String;
    restart: System.Int64;
    customObject: System.TObject
);

public function DownloadFileAsync( 
   localFilePath : System.String,
   ftpFileName : System.String,
   restart : System.long,
   customObject : System.Object
);

public: void DownloadFileAsync( 
   System.string* localFilePath,
   System.string* ftpFileName,
   System.long restart,
   System.Object* customObject
)

public:
void DownloadFileAsync( 
   System.String^ localFilePath,
   System.String^ ftpFileName,
   System.int64 restart,
   System.Object^ customObject
)

Parameters

localFilePath: The local file path
ftpFileName: The FTP file path
restart: The byte offset to start downloading from
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  = "anonymus"; // replace with your user name
sftp.Password = "user@mail.com"; // replace with your password
 
System.Console.WriteLine("We are downloading the a.txt file.  This is a non blocking call");
 
sftp.DownloadFileAsync("c:\\a.txt", "a.txt", 2500);
 
while (sftp.IsBusy == true)
{
    System.Threading.Thread.Sleep(100);
}
 
System.Console.WriteLine("{0} files have been transfered", 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  = "anonymus" ' replace with your user name
sftp.Password = "user@mail.com" ' replace with your password
 
System.Console.WriteLine("We are downloading the a.txt file.  This is a non blocking call")
 
sftp.DownloadFileAsync("c:\a.txt", "a.txt", 2500)
 
Do While sftp.IsBusy = True
   System.Threading.Thread.Sleep(100)
Loop
 
System.Console.WriteLine("{0} files have been transfered", 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