MemoryStream.ReadAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| ReadAsync(Memory<Byte>, CancellationToken) |
Асинхронно считывает последовательность байтов из текущего потока в памяти, записывает ее в |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
Асинхронно считывает последовательность байтов из текущего потока, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены. |
ReadAsync(Memory<Byte>, CancellationToken)
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.cs
Асинхронно считывает последовательность байтов из текущего потока в памяти, записывает ее в destination, перемещает позицию в потоке в памяти на число считанных байтов и отслеживает запросы отмены.
public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> destination, System.Threading.CancellationToken cancellationToken = default);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>override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>Public Overrides Function ReadAsync (destination As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Параметры
- cancellationToken
- CancellationToken
Токен для отслеживания запросов отмены. Значение по умолчанию — None.
Возвращаемое значение
Задача, представляющая асинхронную операцию чтения. Значение свойства Result содержит общее число байтов, считанных в destination. Итоговое значение может быть меньше количества выделенных в destination байтов, если столько байтов в настоящее время недоступно, или оно может равняться нулю (0), если был достигнут конец потока в памяти.
Исключения
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Применяется к
ReadAsync(Byte[], Int32, Int32, CancellationToken)
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.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);[System.Runtime.InteropServices.ComVisible(false)]
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>[<System.Runtime.InteropServices.ComVisible(false)>]
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.
Возвращаемое значение
Задача, представляющая асинхронную операцию чтения. Значение параметра TResult содержит общее число байтов, считанных в буфер. Значение результата может быть меньше запрошенного числа байтов, если число доступных в данный момент байтов меньше запрошенного числа, или результат может быть равен 0 (нулю), если был достигнут конец потока.
- Атрибуты
Исключения
buffer имеет значение null.
offset или count является отрицательным значением.
Сумма offset и count больше, чем длина буфера.
Поток не поддерживает чтение.
Поток был удален.
Поток в настоящее время используется предыдущей операцией чтения.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Если операция отменена до ее завершения, возвращаемая задача содержит Canceled значение свойства Status .
Вы можете создать маркер отмены, создав экземпляр CancellationTokenSource класса и передав свойство Token в cancellationToken качестве параметра .
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Read(Byte[], Int32, Int32).
