CryptoStream.ReadAsync 方法

定義

命名空間:

System.Security.Cryptography

組件:

System.Security.Cryptography.dll

多載

ReadAsync(Byte[], Int32, Int32, CancellationToken)	自目前資料流非同步讀取一連串的位元組、依所讀取的位元組數目進階資料流中的位置，以及監視取消要求。
ReadAsync(Memory<Byte>, CancellationToken)	以非同步的方式從目前資料流讀取一連串的位元組、依所讀取的位元組數目進階資料流中的位置，以及監視取消要求。

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

來源:

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 中的部分和零位元組讀取。

您必須在呼叫 ReadAsync 前面加上 await (C#) 或 Await (Visual Basic) 運算符，才能暫停方法的執行，直到工作完成為止。 如需詳細資訊，請參閱 異步程式設計 (C#) 或使用 Async 和 Await 進行異步程式設計 (Visual Basic) 。

如果作業在完成之前取消，則傳回的工作會 Canceled 包含 屬性的值 Status 。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 Read(Byte[], Int32, Int32)例外狀況。

另請參閱

• 受控執行緒中的取消作業

ReadAsync(Memory<Byte>, CancellationToken)

來源:

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 中的部分和零位元組讀取。