Downloads the specified part of the remote file to the specified offset of the local file.

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

Syntax

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

Parameters

remotePath
Type: System..::..String
The path of the remote file.
localPath
Type: System..::..String
The path of the local file. This cannot be a directory.
remoteOffset
Type: System..::..Int64
The starting offset of the remote file.
localOffset
Type: System..::..Int64
The starting offset in the local file.
length
Type: System..::..Int64
Number of bytes to transfer or -1 to transfer until the 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