NET SFTP Library
DownloadStream(Stream,String,Int64) Method
Example 






KellermanSoftware.NetSFtpLibrary Namespace > SFTP Class > DownloadStream Method : DownloadStream(Stream,String,Int64) Method
The local file stream
The FTP file path
The byte offset to start downloading from.
Download to a file stream from the SSH server synchronously using the specified byte offset.
Syntax
'Declaration
 
Public Overloads Sub DownloadStream( _
   ByVal localStream As System.IO.Stream, _
   ByVal ftpFileName As System.String, _
   ByVal restart As System.Long _
) 
'Usage
 
Dim instance As SFTP
Dim localStream As System.IO.Stream
Dim ftpFileName As System.String
Dim restart As System.Long
 
instance.DownloadStream(localStream, ftpFileName, restart)
public void DownloadStream( 
   System.IO.Stream localStream,
   System.string ftpFileName,
   System.long restart
)
public procedure DownloadStream( 
    localStream: System.IO.Stream;
    ftpFileName: System.String;
    restart: System.Int64
); 
public function DownloadStream( 
   localStream : System.IO.Stream,
   ftpFileName : System.String,
   restart : System.long
);
public: void DownloadStream( 
   System.IO.Stream* localStream,
   System.string* ftpFileName,
   System.long restart
) 
public:
void DownloadStream( 
   System.IO.Stream^ localStream,
   System.String^ ftpFileName,
   System.int64 restart
) 

Parameters

localStream
The local file stream
ftpFileName
The FTP file path
restart
The byte offset to start downloading from.
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
 
Stream myStream = File.OpenWrite("c:\\uploadfile1.txt");
sftp.DownloadStream(myStream, "uploadfile1.txt", 2500);
myStream.Close();
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
 
Dim myStream As Stream = File.OpenWrite("c:\uploadfile1.txt")
sftp.DownloadStream(myStream, "uploadfile1.txt", 2500)
myStream.Close()
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