CryptoStream.ReadAsync 方法

定义

命名空间:

System.Security.Cryptography

程序集:

System.Security.Cryptography.dll

重载

ReadAsync(Byte[], Int32, Int32, CancellationToken)	从当前流异步读取字节序列，将此流中的位置提升读取的字节数，并监视取消请求数。
ReadAsync(Memory<Byte>, CancellationToken)	从当前流异步读取字节的序列，将流中的位置提升读取的字节数，并监视取消请求。

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

Source:

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。

返回

Task<Int32>

表示异步读取操作的任务。 目标对象的 TResult 参数的值包含多次读入缓冲区总字节数。 如果当前可用字节数少于所请求的字节数，则该结果值可能小于所请求的字节数，或者如果已到达流的末尾时，则为 0（零）。

例外

ArgumentNullException

buffer 为 null。

ArgumentOutOfRangeException

offset 或 count 为负数。

ArgumentException

offset 和 count 的总和大于缓冲区长度。

NotSupportedException

流不支持读取。

ObjectDisposedException

已释放流。

InvalidOperationException

之前的读取操作当前正在使用流。

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

重要

从 .NET 6 开始，此方法读取的字节数可能与请求的字节数不一样多。 有关详细信息，请参阅 DeflateStream、GZipStream 和 CryptoStream 中的部分读取和零字节读取。

必须使用 (C#) 或 Await (Visual Basic) 运算符来在调用 ReadAsyncawait 前暂停执行方法，直到任务完成。 有关详细信息，请参阅 异步编程 (C#) 或使用 Async 和 Await (Visual Basic) 异步编程 。

如果在操作完成之前取消，则返回的任务将 Canceled 包含 属性的值 Status 。

此方法存储在任务中，它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中，则在等待任务时将引发该异常。 使用异常（如 ArgumentException）仍会同步引发。 有关存储的异常，请参阅 引发的 Read(Byte[], Int32, Int32)异常。

另请参阅

• 托管线程中的取消

ReadAsync(Memory<Byte>, CancellationToken)

Source:

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)

参数

buffer

Memory<Byte>

要将数据写入的内存区域。

cancellationToken

CancellationToken

要监视取消请求的标记。 默认值为 None。

返回

ValueTask<Int32>

表示异步读取操作的任务。 其 Result 属性的值包含读入缓冲区的总字节数。 如果很多字节当前不可用，则结果值可小于在缓冲区中分配的字节数；如果已到达流结尾，则结果值可以为 0（零）。

例外

NotSupportedException

CryptoStreamMode与当前CryptoStream对象关联的 与基础流不匹配。 例如，与仅写入的基础流一起使用 Read 时，会引发此异常。

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。

注解

从 .NET 6 开始，此方法读取的字节数可能与请求的字节数不一样多。 有关详细信息，请参阅 DeflateStream、GZipStream 和 CryptoStream 中的部分读取和零字节读取。