NET SFTP Library
ResumeDownloadFileAsync(String,String,Object) Method
Example 






KellermanSoftware.NetSFtpLibrary Namespace > SFTP Class > ResumeDownloadFileAsync Method : ResumeDownloadFileAsync(String,String,Object) Method
The local file path to download to
The FTP path to download from
Your custom object to be returned with Started, Progress, and Completed Events
Resume downloading a file asynchronously. It automatically starts at where it left off.
Syntax
'Declaration
 
Public Overloads Sub ResumeDownloadFileAsync( _
   ByVal localFilePath As System.String, _
   ByVal ftpFileName As System.String, _
   ByVal customObject As System.Object _
) 
'Usage
 
Dim instance As SFTP
Dim localFilePath As System.String
Dim ftpFileName As System.String
Dim customObject As System.Object
 
instance.ResumeDownloadFileAsync(localFilePath, ftpFileName, customObject)
public void ResumeDownloadFileAsync( 
   System.string localFilePath,
   System.string ftpFileName,
   System.object customObject
)
public procedure ResumeDownloadFileAsync( 
    localFilePath: System.String;
    ftpFileName: System.String;
    customObject: System.TObject
); 
public function ResumeDownloadFileAsync( 
   localFilePath : System.String,
   ftpFileName : System.String,
   customObject : System.Object
);
public: void ResumeDownloadFileAsync( 
   System.string* localFilePath,
   System.string* ftpFileName,
   System.Object* customObject
) 
public:
void ResumeDownloadFileAsync( 
   System.String^ localFilePath,
   System.String^ ftpFileName,
   System.Object^ customObject
) 

Parameters

localFilePath
The local file path to download to
ftpFileName
The FTP path to download from
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
 
System.Console.WriteLine("We are downloading the a.txt file.This is a blocking call");
 
sftp.ResumeDownloadFileAsync("a.txt", "a.txt");
 
while (sftp.IsBusy == true)
{
    System.Threading.Thread.Sleep(100);
}
 
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
 
System.Console.WriteLine("We are downloading the a.txt file.This is a blocking call")
 
sftp.ResumeDownloadFileAsync("a.txt", "a.txt")
 
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

See Also

Reference

SFTP Class
SFTP Members
Overload List