Begins asynchronous GetStream operation. Returns a Stream for reading data from the remote file.

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

Syntax

Visual Basic
Public Function BeginGetStream ( _
	remotePath As String, _
	mode As FileMode, _
	access As FileAccess, _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
C#
public IAsyncResult BeginGetStream(
	string remotePath,
	FileMode mode,
	FileAccess access,
	AsyncCallback callback,
	Object state
)

Parameters

remotePath
Type: System..::..String
The path of the remote file.
mode
Type: System.IO..::..FileMode
How to open the remote file.
access
Type: System.IO..::..FileAccess
Which operations can be performed on the opened stream.
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

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