Begins asynchronous GetFile operation. Downloads the remote file to the data stream.

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

Syntax

Visual Basic
Public Function BeginGetFile ( _
	remotePath As String, _
	outputStream As Stream, _
	remoteOffset As Long, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginGetFile(
	string remotePath,
	Stream outputStream,
	long remoteOffset,
	AsyncCallback callback,
	Object state
)

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.
callback
Type: System..::..AsyncCallback
An optional asynchronous callback to be called when the operation is complete.
state
Type: System..::..Object
A user-provided object that identifies this particular asynchronous operation.

Return Value

An IAsyncResult that references the asynchronous operation.

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.

In builds for .NET 4.0 and higher, this method is available as an extension method. Add 'using Rebex.Legacy' (C#) or 'Import Rebex.Legacy' (VB.NET) to your code in order to use it.

Version Information

.NET Compact Framework

Supported in: 3.9, 3.5

See Also