Downloads the remote file to the local file.

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

Syntax

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

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.

Return Value

Number of bytes transferred.

Implements

IFtp..::..GetFile(String, String, Int64, Int64)

Remarks

Represents FTP RETR command.

If the specified local file does not exist, it is created; if it does exist and the local offset is greater than 0, the contents after the offset are overwritten.

If the localOffset is less than or equal to zero and the file exists, it will be truncated to zero length before the transfer starts.

The path parameter can specify either relative or absolute path. Relative path is interpreted as relative to the current working directory. Use GetCurrentDirectory to obtain the current working directory.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also