MemoryStream.ReadAsync Metoda

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Zestaw:

System.Runtime.Extensions.dll

Zestaw:

netstandard.dll

Zestaw:

System.IO.dll

Zestaw:

mscorlib.dll

Przeciążenia

ReadAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia pamięci, zapisuje sekwencję na destination, zwiększa pozycję w strumieniu pamięci o liczbę odczytanych bajtów i monitoruje żądania anulowania.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia, 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 pamięci, zapisuje sekwencję na destination, zwiększa pozycję w strumieniu pamięci o liczbę odczytanych bajtów i monitoruje żądania anulowania.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> destination, System.Threading.CancellationToken cancellationToken = default);

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>

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (destination As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parametry

destinationbuffer

Memory<Byte>

Region pamięci do zapisu danych.

cancellationToken

CancellationToken

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

Zwraca

ValueTask<Int32>

Zadanie reprezentujące operację odczytu asynchronicznego. Wartość jej Result właściwości zawiera całkowitą liczbę bajtów odczytanych w obiekcie destination. Wartość wyniku może być mniejsza niż liczba bajtów przydzielonych, destination jeśli liczba bajtów nie jest obecnie dostępna lub może być równa 0 (zero), jeśli osiągnięto koniec strumienia pamięci.

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

Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia, 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);

[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)

Parametry

buffer

Byte[]

Bufor do zapisania danych.

offset

Int32

Przesunięcie bajtów, w buffer którym rozpocznie się 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 operację odczytu asynchronicznego. Wartość parametru TResult zawiera całkowitą liczbę bajtów odczytanych do buforu. Wartość wyniku może być mniejsza niż liczba bajtów żądanych, jeśli liczba obecnie dostępnych bajtów jest mniejsza niż żądana liczba lub może być 0 (zero), jeśli koniec strumienia został osiągnięty.

Atrybuty

ComVisibleAttribute

Wyjątki

ArgumentNullException

buffer to null.

ArgumentOutOfRangeException

offset lub count jest ujemny.

ArgumentException

Suma offset 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.

Uwagi

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

Token anulowania można utworzyć, tworząc wystąpienie CancellationTokenSource klasy i przekazując Token właściwość jako cancellationToken parametr.