Stream.ReadAsync Metoda

Definice

Obor názvů:

System.IO

Sestavení:

netstandard.dll, System.Runtime.dll

Asynchronně čte posloupnost bajtů z aktuálního datového proudu a posune pozici v datovém proudu o počet přečtených bajtů.

Přetížení

Name	Description
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje žádosti o zrušení.
ReadAsync(Byte[], Int32, Int32)	Asynchronně čte posloupnost bajtů z aktuálního datového proudu a posune pozici v datovém proudu o počet přečtených bajtů.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje žádosti o zrušení.

ReadAsync(Memory<Byte>, CancellationToken)

Zdroj:

Stream.cs

Asynchronně přečte posloupnost bajtů z aktuálního datového proudu, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje žádosti o zrušení.

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

abstract member 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 Overridable Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parametry

buffer

Memory<Byte>

Oblast paměti pro zápis dat do.

cancellationToken

CancellationToken

Token pro monitorování žádostí o zrušení. Výchozí hodnota je None.

Návraty

ValueTask<Int32>

Úloha, která představuje asynchronní operaci čtení. Hodnota jeho Result vlastnosti obsahuje celkový počet bajtů přečtených do vyrovnávací paměti. Výsledná hodnota může být menší než délka vyrovnávací paměti, pokud není aktuálně k dispozici mnoho bajtů, nebo může být 0 (nula), pokud je délka vyrovnávací paměti 0 nebo pokud byl dosažen konec datového proudu.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.

Poznámky

Tato ReadAsync metoda umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je zvlášť důležitý v aplikaci pro Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a zobrazit aplikaci, jako by nefungovala. Asynchronní metody se používají ve spojení s async klíčovými await slovy v jazyce Visual Basic a C#.

CanRead Pomocí vlastnosti určete, zda aktuální instance podporuje čtení.

Pokud je operace zrušena před dokončením, vrácený úkol obsahuje TaskStatus.Canceled hodnotu vlastnosti Status .

Podívejte se například na ReadAsync(Byte[], Int32, Int32) přetížení.

ReadAsync(Byte[], Int32, Int32)

Zdroj:

Stream.cs

Asynchronně čte posloupnost bajtů z aktuálního datového proudu a posune pozici v datovém proudu o počet přečtených bajtů.

public:
 System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count);

public System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count);

member this.ReadAsync : byte[] * int * int -> System.Threading.Tasks.Task<int>

Public Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer) As Task(Of Integer)

Parametry

buffer

Byte[]

Vyrovnávací paměť pro zápis dat do.

offset

Int32

Posun bajtů, při buffer kterém se mají začít zapisovat data z datového proudu.

count

Int32

Maximální počet bajtů, které se mají přečíst.

Návraty

Task<Int32>

Úloha, která představuje asynchronní operaci čtení. Hodnota parametru TResult obsahuje celkový počet bajtů načtených do vyrovnávací paměti. Výsledná hodnota může být menší než počet bajtů požadovaných v případě, že je počet bajtů aktuálně k dispozici menší než požadované číslo, nebo může být 0 (nula), pokud count je 0 nebo pokud byl dosažen konec datového proudu.

Výjimky

ArgumentNullException

buffer je null.

ArgumentOutOfRangeException

offset nebo count je negativní.

ArgumentException

Součet offset a count je větší než délka vyrovnávací paměti.

NotSupportedException

Stream nepodporuje čtení.

ObjectDisposedException

Stream byl odstraněn.

InvalidOperationException

Stream se aktuálně používá předchozí operací čtení.

Příklady

Následující příklad ukazuje, jak číst ze souboru asynchronně. Příklad používá FileStream třídu, která je odvozena z Stream třídy.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Poznámky

Tato ReadAsync metoda umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je zvlášť důležitý v aplikaci pro Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a zobrazit aplikaci, jako by nefungovala. Asynchronní metody se používají ve spojení s async klíčovými await slovy v jazyce Visual Basic a C#.

CanRead Pomocí vlastnosti určete, zda aktuální instance podporuje čtení.

Tato metoda ukládá do úlohy všechny výjimky bez použití, které může vyvolat synchronní protějšek metody. Pokud je výjimka uložena do vrácené úlohy, tato výjimka bude vyvolána, když je úkol očekáván. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. V případě uložených výjimek se podívejte na výjimky vyvolané Read(Byte[], Int32, Int32).

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

Zdroj:

Stream.cs

Asynchronně přečte posloupnost bajtů z aktuálního datového proudu, posune pozici v datovém proudu o počet přečtených bajtů a monitoruje žádosti o zrušení.

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public virtual System.Threading.Tasks.Task<int> ReadAsync(byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

abstract member ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>
override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overridable Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parametry

buffer

Byte[]

Vyrovnávací paměť pro zápis dat do.

offset

Int32

Posun bajtů, při buffer kterém se mají začít zapisovat data z datového proudu.

count

Int32

Maximální počet bajtů, které se mají přečíst.

cancellationToken

CancellationToken

Token pro monitorování žádostí o zrušení. Výchozí hodnota je None.

Návraty

Task<Int32>

Úloha, která představuje asynchronní operaci čtení. Hodnota parametru TResult obsahuje celkový počet bajtů načtených do vyrovnávací paměti. Výsledná hodnota může být menší než počet bajtů požadovaných v případě, že je počet bajtů aktuálně k dispozici menší než požadované číslo, nebo může být 0 (nula), pokud count je 0 nebo pokud byl dosažen konec datového proudu.

Výjimky

ArgumentNullException

buffer je null.

ArgumentOutOfRangeException

offset nebo count je negativní.

ArgumentException

Součet offset a count je větší než délka vyrovnávací paměti.

NotSupportedException

Stream nepodporuje čtení.

ObjectDisposedException

Stream byl odstraněn.

InvalidOperationException

Stream se aktuálně používá předchozí operací čtení.

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka je uložena do vrácené úlohy.

Poznámky

Tato ReadAsync metoda umožňuje provádět vstupně-výstupní operace náročné na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je zvlášť důležitý v aplikaci pro Windows 8.x Store nebo desktopové aplikaci, kde časově náročná operace streamu může blokovat vlákno uživatelského rozhraní a zobrazit aplikaci, jako by nefungovala. Asynchronní metody se používají ve spojení s async klíčovými await slovy v jazyce Visual Basic a C#.

CanRead Pomocí vlastnosti určete, zda aktuální instance podporuje čtení.

Pokud je operace zrušena před dokončením, vrácený úkol obsahuje Canceled hodnotu vlastnosti Status .

Podívejte se například na ReadAsync(Byte[], Int32, Int32) přetížení.

Tato metoda ukládá do úlohy všechny výjimky bez použití, které může vyvolat synchronní protějšek metody. Pokud je výjimka uložena do vrácené úlohy, tato výjimka bude vyvolána, když je úkol očekáván. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. V případě uložených výjimek se podívejte na výjimky vyvolané Read(Byte[], Int32, Int32).

Viz také

• Zrušení