Downloads the remote file to the data stream.

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

Syntax

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

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.

Return Value

Number of bytes transferred.

Implements

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

Remarks

Represents FTP RETR command.

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