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

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

Syntax

Visual Basic
Public Function BeginGetFile ( _
	remotePath As String, _
	outputStream As Stream, _
	remoteOffset As Long, _
	length As Long, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginGetFile(
	string remotePath,
	Stream outputStream,
	long remoteOffset,
	long length,
	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.
length
Type: System..::..Int64
Number of bytes to transfer or -1 to transfer all data until an end is reached.
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

If the local file does not exist, it is created.

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