CryptoStream.ReadAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| ReadAsync(Byte[], Int32, Int32, CancellationToken) |
Асинхронно считывает последовательность байтов из текущего потока, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены. |
| ReadAsync(Memory<Byte>, CancellationToken) |
Асинхронно считывает последовательность байтов из текущего потока, перемещает позицию в потоке на число считанных байтов и отслеживает запросы отмены. |
- Исходный код:
- CryptoStream.cs
- Исходный код:
- CryptoStream.cs
- Исходный код:
- CryptoStream.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.
Возвращаемое значение
Задача, представляющая асинхронную операцию чтения. Значение параметра TResult объекта задач содержит общее число байтов, считанных в буфер. Результат может быть меньше запрошенного числа байтов, если число текущих доступных байтов меньше запрошенного числа, или результат может быть равен 0 (нулю), если был достигнут конец потока.
Исключения
buffer имеет значение null.
offset или count является отрицательным значением.
Сумма offset и count больше, чем длина буфера.
Поток не поддерживает чтение.
Поток был удален.
Поток в настоящее время используется предыдущей операцией чтения.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Важно!
Начиная с .NET 6 этот метод может считывать не столько байтов, сколько было запрошено. Дополнительные сведения см. в разделе Частичные и нулевые операции чтения в DeflateStream, GZipStream и CryptoStream.
Чтобы приостановить выполнение метода до завершения задачи, необходимо предварить ReadAsyncawait вызов с помощью оператора (C#) или Await (Visual Basic). Дополнительные сведения см. в разделах Асинхронное программирование (C#) или Асинхронное программирование с помощью Async и Await (Visual Basic).
Если операция отменена до ее завершения, возвращаемая задача содержит Canceled значение Status свойства .
Этот метод сохраняет в задаче все исключения, не относящиеся к использованию, которые может создавать синхронный аналог метода. Если исключение сохраняется в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Хранимые исключения см. в разделе исключения, создаваемые Read(Byte[], Int32, Int32).
См. также раздел
Применяется к
.NET 10 и другие версии
| Продукт | Версии |
|---|---|
| .NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
| .NET Framework | 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
| .NET Standard | 1.3, 1.4, 1.6, 2.0, 2.1 |
- Исходный код:
- CryptoStream.cs
- Исходный код:
- CryptoStream.cs
- Исходный код:
- CryptoStream.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)Параметры
- cancellationToken
- CancellationToken
Токен для отслеживания запросов отмены. Значение по умолчанию — None.
Возвращаемое значение
Задача, представляющая асинхронную операцию чтения. Значение свойства Result содержит общее число байтов, считанных в буфер. Итоговое значение может быть меньше количества выделенных в буфере байтов, если столько байтов в настоящее время недоступно, или оно может равняться нулю (0), если был достигнут конец потока.
Исключения
Объект , CryptoStreamMode связанный с текущим CryptoStream объектом, не соответствует базовому потоку. Например, это исключение возникает при использовании Read с базовым потоком, который является только записью.
Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.
Комментарии
Начиная с .NET 6 этот метод может считывать не столько байтов, сколько было запрошено. Дополнительные сведения см. в разделе Частичные и нулевые операции чтения в DeflateStream, GZipStream и CryptoStream.
Применяется к
.NET 10 и другие версии
| Продукт | Версии |
|---|---|
| .NET | 6, 7, 8, 9, 10 |
