DownloadFile(String,String,Int64,Int64) Method

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

'Declaration
 
Public Overloads Sub DownloadFile( _
   ByVal localFilePath As System.String, _
   ByVal ftpFileName As System.String, _
   ByVal restart As System.Long, _
   ByVal maxLength As System.Long _
)

'Usage
 
Dim instance As SFTP
Dim localFilePath As System.String
Dim ftpFileName As System.String
Dim restart As System.Long
Dim maxLength As System.Long
 
instance.DownloadFile(localFilePath, ftpFileName, restart, maxLength)

public void DownloadFile( 
   System.string localFilePath,
   System.string ftpFileName,
   System.long restart,
   System.long maxLength
)

public procedure DownloadFile( 
    localFilePath: System.String;
    ftpFileName: System.String;
    restart: System.Int64;
    maxLength: System.Int64
);

public function DownloadFile( 
   localFilePath : System.String,
   ftpFileName : System.String,
   restart : System.long,
   maxLength : System.long
);

public: void DownloadFile( 
   System.string* localFilePath,
   System.string* ftpFileName,
   System.long restart,
   System.long maxLength
)

public:
void DownloadFile( 
   System.String^ localFilePath,
   System.String^ ftpFileName,
   System.int64 restart,
   System.int64 maxLength
)

Parameters

localFilePath: The full path of the file, including the file name
ftpFileName: The full path of the FTP file, including the ftp directory and file name
restart: The byte offset to start downloading
maxLength: The number of bytes to download

C#

SFTP sftp = new SFTP(); //Trial Mode            
//SFTP sftp = new SFTP("place user name here", "place license key here");
 
// set the name of the SFTP 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.DownloadFile("a.txt", "a.txt");
 
System.Console.WriteLine("{0} files have been Transferred", sftp.FileCount);

Visual Basic

Dim sftp As SFTP = New SFTP() 'Trial Mode
'Dim sftp = New SFTP("place user name here", "place license key here")
 
' set the name of the SFTP 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.DownloadFile("a.txt", "a.txt")
 
System.Console.WriteLine("{0} files have been Transferred", 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