Begins asynchronous GetFile operation. Downloads the remote file to the local file.

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

Syntax

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

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.
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.

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.

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