Bounded StreamRead Async(Byte, Int 32, Int 32, Cancellation Token) Method
Asynchronously read a sequence of bytes from the stream and advances the position
within the stream by the number of bytes read.
Definition
Namespace: MimeKit.IO
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public override Task<int> ReadAsync(
byte[] buffer,
int offset,
int count,
CancellationToken cancellationToken
)Parameters
- buffer Byte
- The buffer to read data into.
- offset Int32
- The offset into the buffer to start reading data.
- count Int32
- The number of bytes to read.
- cancellationToken CancellationToken
- The cancellation token.
Return Value
TaskInt32The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
Remarks
Reads data from the BaseStream, not allowing it to
read beyond the EndBoundary.
Exceptions
| ArgumentNullException | buffer is . |
| ArgumentOutOfRangeException |
offset is less than zero or greater than the length of buffer. -or- The buffer is not large enough to contain count bytes starting at the specified offset. |
| ObjectDisposedException | The stream has been disposed. |
| NotSupportedException | The stream does not support reading. |
| OperationCanceledException | The operation was canceled via the cancellation token. |
| IOException | An I/O error occurred. |