SftpFileStream BeginRead Method SSH .NET Client Library Documentation
Begins an asynchronous read operation.

Namespace: Renci.SshNet.Sftp
Assembly: Renci.SshNet (in Renci.SshNet.dll) Version: 0.1.0.0 (1.0.0.0)
Syntax

public override IAsyncResult BeginRead(
	byte[] buffer,
	int offset,
	int count,
	AsyncCallback callback,
	Object state
)

Parameters

buffer
Type:  OnlineSystem Byte 
The buffer to read the data into.
offset
Type: OnlineSystem Int32
The byte offset in buffer at which to begin writing data read from the stream.
count
Type: OnlineSystem Int32
The maximum number of bytes to read.
callback
Type: OnlineSystem AsyncCallback
An optional asynchronous callback, to be called when the read is complete.
state
Type: OnlineSystem Object
A user-provided object that distinguishes this particular asynchronous read request from other requests.

Return Value

An OnlineIAsyncResult that represents the asynchronous read, which could still be pending.
Exceptions

ExceptionCondition
OnlineSystem.IO IOExceptionAttempted an asynchronous read past the end of the stream, or a disk error occurs.
OnlineSystem ArgumentExceptionOne or more of the arguments is invalid.
OnlineSystem ObjectDisposedExceptionMethods were called after the stream was closed.
OnlineSystem NotSupportedExceptionThe current Stream implementation does not support the read operation.
See Also