Downloads the specified part of the remote file to the data stream.

Namespace:  Rebex.Net
Assembly:  Rebex.Sftp (in Rebex.Sftp.dll)

Syntax

Visual Basic
Public Function GetFile ( _
	remotePath As String, _
	outputStream As Stream, _
	remoteOffset As Long, _
	length As Long _
) As Long
C#
public long GetFile(
	string remotePath,
	Stream outputStream,
	long remoteOffset,
	long length
)

Parameters

remotePath
Type: System..::..String
The path of the remote file.
outputStream
Type: System.IO..::..Stream
The output stream.
remoteOffset
Type: System..::..Int64
The starting offset of the remote file.
length
Type: System..::..Int64
Number of bytes to transfer or -1 to transfer all data until an end is reached.

Return Value

Number of bytes transferred.

Remarks

If the local file does not exist, it is created.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also