Begins an asynchronous read operation.
Namespace: Renci.SshNet.SftpAssembly: 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:
System Byte
The buffer to read the data into.
- offset
- Type:
System Int32
The byte offset in buffer at which to begin writing data read from the stream.
- count
- Type:
System Int32
The maximum number of bytes to read.
- callback
- Type:
System AsyncCallback
An optional asynchronous callback, to be called when the read is complete.
- state
- Type:
System Object
A user-provided object that distinguishes this particular asynchronous read request from other requests.
Return Value
AnExceptions
| Exception | Condition |
|---|---|
| Attempted an asynchronous read past the end of the stream, or a disk error occurs. | |
| One or more of the arguments is invalid. | |
| Methods were called after the stream was closed. | |
| The current Stream implementation does not support the read operation. |
See Also