CryptoStream.ReadAsync Metoda

Definicja

Przestrzeń nazw:

System.Security.Cryptography

Zestaw:

System.Security.Cryptography.dll

Przeciążenia

ReadAsync(Byte[], Int32, Int32, CancellationToken)	Odczytuje sekwencję bajtów z bieżącego strumienia asynchronicznie, rozwija pozycję w strumieniu według liczby odczytanych bajtów i monitoruje żądania anulowania.
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia, przesuwa pozycję w strumieniu o liczbę odczytanych bajtów i monitoruje żądania anulowania.

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

Źródło:

CryptoStream.cs

Odczytuje sekwencję bajtów z bieżącego strumienia asynchronicznie, rozwija pozycję w strumieniu według liczby odczytanych bajtów i monitoruje żądania anulowania.

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)

Parametry

buffer

Byte[]

Bufor do zapisania danych.

offset

Int32

Przesunięcie bajtu, w buffer którym należy rozpocząć zapisywanie danych ze strumienia.

count

Int32

Maksymalna liczba bajtów do odczytania.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

Task<Int32>

Zadanie reprezentujące asynchroniczną operację odczytu. Wartość parametru obiektu TResult zadania zawiera całkowitą liczbę bajtów odczytanych do buforu. Wynik może być mniejszy niż liczba bajtów żądanych, jeśli liczba obecnie dostępnych bajtów jest mniejsza niż żądana liczba lub może być równa 0 (zero), jeśli koniec strumienia został osiągnięty.

Wyjątki

ArgumentNullException

buffer to null.

ArgumentOutOfRangeException

offset lub count jest ujemny.

ArgumentException

Suma offset wartości i count jest większa niż długość buforu.

NotSupportedException

Strumień nie obsługuje odczytu.

ObjectDisposedException

Strumień został usunięty.

InvalidOperationException

Strumień jest obecnie używany przez poprzednią operację odczytu.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Ważne

Począwszy od platformy .NET 6, ta metoda może nie odczytywać tyle bajtów, ile żądano. Aby uzyskać więcej informacji, zobacz Częściowe i zerowe odczyty odczytów w DeflateStream, GZipStream i CryptoStream.

Musisz wstępnie poprzeć wywołanie metody ReadAsync za pomocą await operatora (C#) lub Await (Visual Basic), aby wstrzymać wykonywanie metody do czasu ukończenia zadania. Aby uzyskać więcej informacji, zobacz Programowanie asynchroniczne (C#) lub Programowanie asynchroniczne przy użyciu Async and Await (Visual Basic).

Jeśli operacja zostanie anulowana przed jej zakończeniem, zwrócone zadanie zawiera Canceled wartość właściwości Status .

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez Read(Byte[], Int32, Int32)usługę .

Zobacz też

• Anulowanie w zarządzanych wątkach

ReadAsync(Memory<Byte>, CancellationToken)

Źródło:

CryptoStream.cs

Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia, przesuwa pozycję w strumieniu o liczbę odczytanych bajtów i monitoruje żądania anulowania.

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)

Parametry

buffer

Memory<Byte>

Region pamięci do zapisywania danych.

cancellationToken

CancellationToken

Token do monitorowania żądań anulowania. Wartość domyślna to None.

Zwraca

ValueTask<Int32>

Zadanie reprezentujące asynchroniczną operację odczytu. Wartość jej Result właściwości zawiera całkowitą liczbę bajtów odczytanych do buforu. Wartość wyniku może być mniejsza niż liczba bajtów przydzielonych w buforze, jeśli liczba bajtów jest obecnie niedostępna lub może być równa 0 (zero), jeśli koniec strumienia został osiągnięty.

Wyjątki

NotSupportedException

Obiekt CryptoStreamMode skojarzony z bieżącym CryptoStream obiektem jest niezgodny ze strumieniem bazowym. Na przykład ten wyjątek jest zgłaszany podczas korzystania Read z bazowego strumienia, który jest tylko zapisem.

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Począwszy od platformy .NET 6, ta metoda może nie odczytywać tyle bajtów, ile żądano. Aby uzyskać więcej informacji, zobacz Częściowe i zerowe odczyty odczytów w DeflateStream, GZipStream i CryptoStream.