NET FTP Library
DownloadFileAsync(String,String,Int64,Object) Method
Example 






KellermanSoftware.NetFtpLibrary Namespace > FTP Class > DownloadFileAsync Method : DownloadFileAsync(String,String,Int64,Object) Method
The local file path
The FTP file path
The byte offset to start downloading from
Your custom object to be returned with Started, Progress, and Completed Events
Download a file from the FTP server asynchronously from the specified byte offset.
Syntax
'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 FTP
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
Example
FTP ftp = new FTP(); //Trial Mode            
//FTP ftp = new FTP("place user name here", "place license key here");
 
// set the name of the FTP server( its URL )
ftp.HostAddress = "ftp.fsz.bme.hu"; // a hungarian university. change this to your ftp server
ftp.UserName = "anonymus"; // replace with your user name
ftp.Password = "user@mail.com"; // replace with your password
 
System.Console.WriteLine("We are downloading the a.txt file.  This is a non blocking call");
 
ftp.DownloadFileAsync("c:\\a.txt", "a.txt", 2500);
 
while (ftp.IsBusy == true)
{
    System.Threading.Thread.Sleep(100);
}
 
System.Console.WriteLine("{0} files have been transfered", ftp.FileCount);
Dim ftp As FTP = New FTP() 'Trial Mode
'FTP ftp = new FTP("place user name here", "place license key here");
 
' set the name of the FTP server( its URL )
ftp.HostAddress = "ftp.fsz.bme.hu" ' a hungarian university. change this to your ftp server
ftp.UserName = "anonymus" ' replace with your user name
ftp.Password = "user@mail.com" ' replace with your password
 
System.Console.WriteLine("We are downloading the a.txt file.  This is a non blocking call")
 
ftp.DownloadFileAsync("c:\a.txt", "a.txt", 2500)
 
Do While ftp.IsBusy = True
   System.Threading.Thread.Sleep(100)
Loop
 
System.Console.WriteLine("{0} files have been transfered", ftp.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

FTP Class
FTP Members
Overload List