UnmanagedMemoryStream.ReadAsync Метод

Определение

Пространство имен:

System.IO

Сборка:

System.Runtime.dll

Перегрузки

ReadAsync(Memory<Byte>, CancellationToken)	Асинхронно считывает байты неуправляемого потока памяти в область памяти.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Считывает в асинхронном режиме указанное число байтов в указанный массив.

ReadAsync(Memory<Byte>, CancellationToken)

Source:

UnmanagedMemoryStream.cs

Асинхронно считывает байты неуправляемого потока памяти в область памяти.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Параметры

buffer

Memory<Byte>

По завершении асинхронного метода эта область памяти содержит все байты, считанные из неуправляемого потока памяти.

cancellationToken

CancellationToken

Токен для отслеживания запросов отмены. Значение по умолчанию — None.

Возвращаемое значение

ValueTask<Int32>

Задача, которая представляет асинхронную операцию чтения, и переносит общее число считанных байтов в буфер.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Source:

UnmanagedMemoryStream.cs

Считывает в асинхронном режиме указанное число байтов в указанный массив.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Параметры

buffer

Byte[]

Буфер, в который записываются данные.

offset

Int32

Смещение байтов в buffer, с которого начинается запись данных из потока.

count

Int32

Максимальное число байтов, предназначенных для чтения.

cancellationToken

CancellationToken

Токен для отслеживания запросов отмены. Значение по умолчанию — None.

Возвращаемое значение

Task<Int32>

Задача, представляющая асинхронную операцию чтения. Значение параметра TResult содержит общее число байтов, считанных в буфер. Значение результата может быть меньше запрошенного числа байтов, если число доступных в данный момент байтов меньше запрошенного числа, или результат может быть равен 0 (нулю), если был достигнут конец потока.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

Комментарии

Если во время операции чтения возникает исключение, оно будет задано как Task.Exception свойство возвращаемой задачи.

Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Read(Byte[], Int32, Int32).