MemoryStream.ReadAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| Имя | Описание |
|---|---|
| ReadAsync(Memory<Byte>, CancellationToken) |
Асинхронно считывает последовательность байтов из текущего потока памяти, записывает последовательность |
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
Асинхронно считывает последовательность байтов из текущего потока, перемещает положение в потоке по количеству операций чтения байтов и отслеживает запросы на отмену. |
ReadAsync(Memory<Byte>, CancellationToken)
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.cs
- Исходный код:
- MemoryStream.cs
Асинхронно считывает последовательность байтов из текущего потока памяти, записывает последовательность destinationв , перемещает позицию в поток памяти по количеству байтов чтения и отслеживает запросы на отмену.
public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<byte> destination, 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 (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)Public Overrides Function ReadAsync (destination 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
- Исходный код:
- 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).
