FileStream.ReadAsync Metoda

Reference

Definice

Obor názvů:: System.IO

Sestavení:: System.Runtime.dll

Sestavení:: netstandard.dll

Sestavení:: mscorlib.dll, System.IO.FileSystem.dll

Sestavení:: System.IO.FileSystem.dll

Sestavení:: mscorlib.dll

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Přetížení

ReadAsync(Memory<Byte>, CancellationToken)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu souboru a zapíše je do oblasti paměti, posune pozici v datovém proudu souboru o počet přečtených bajtů a monitoruje požadavky na zrušení.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu souboru a zapíše je do pole bajtů začínajícího na zadaném posunu, posune pozici v datovém proudu souboru o počet přečtených bajtů a monitoruje požadavky na zrušení.

ReadAsync(Memory<Byte>, CancellationToken)

Zdroj:: FileStream.cs

Zdroj:: FileStream.cs

Zdroj:: FileStream.cs

Asynchronně přečte posloupnost bajtů z aktuálního datového proudu souboru a zapíše je do oblasti paměti, posune pozici v datovém proudu souboru o počet přečtených bajtů a monitoruje požadavky na zrušení.

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>

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

cancellationToken: CancellationToken

Token, který se má monitorovat pro žádosti o zrušení. Výchozí hodnota je None.

Návraty

ValueTask<Int32>

Úloha, která představuje asynchronní operaci čtení a zabalí celkový počet přečtených bajtů do vyrovnávací paměti. Výsledná hodnota může být menší než počet požadovaných bajtů, pokud je počet aktuálně dostupných bajtů menší než požadovaný počet, nebo může být 0 (nula), pokud bylo dosaženo konce datového proudu.

Výjimky

OperationCanceledException

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

Příklady

Následující příklad ukazuje, jak číst ze souboru asynchronně.

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);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

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

Metoda ReadAsync umožňuje provádět operace se soubory náročnými na prostředky bez blokování hlavního vlákna. Tento faktor výkonu je obzvláště 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 vaše aplikace vypadat, jako by nefungovala. Asynchronní metody se používají ve spojení s klíčovými async slovy a await v jazyce Visual Basic a C#.

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

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat TaskStatus.Canceled hodnotu vlastnosti Status . Pokud je popisovač souboru odstraněn, vrácený úkol obsahuje ObjectDisposedException výjimku ve Task.Exception vlastnosti.

Platí pro

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

Zdroj:: FileStream.cs

Zdroj:: FileStream.cs

Zdroj:: FileStream.cs

Asynchronně přečte posloupnost bajtů z aktuálního datového proudu souboru a zapíše je do pole bajtů začínajícího na zadaném posunu, posune pozici v datovém proudu souboru o počet přečtených bajtů a monitoruje požadavky na zrušení.

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

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

offset: Int32

Odsazení bajtu, při buffer kterém se mají začít zapisovat data ze streamu.

count: Int32

Maximální počet bajtů ke čtení.

cancellationToken: CancellationToken

Token, který se má monitorovat pro žádosti o zrušení.

Návraty

Task<Int32>

Atributy: ComVisibleAttribute

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

Datový proud byl odstraněn.

InvalidOperationException

Datový proud je aktuálně používán předchozí operací čtení.

OperationCanceledException

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

Příklady

Následující příklad ukazuje, jak číst ze souboru asynchronně.

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);
        }
    }
}

open System.Text
open System.IO

let read () =
    task {
        let filename = @"c:\Temp\userinputlog.txt"
        use sourceStream = File.Open(filename, FileMode.Open)
        let length = int sourceStream.Length    
        let result = Array.zeroCreate length 
        let! _ = sourceStream.ReadAsync(result, 0, length)
        return Encoding.ASCII.GetString result
    }

let main =
    task {
        let! text = read ()
        printfn $"{text}"
    }    
main.Wait()

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

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

Pokud je operace zrušena před dokončením, bude vrácená úloha obsahovat TaskStatus.Canceled hodnotu vlastnosti Task.Status . Pokud je popisovač souboru odstraněn, vrácený úkol obsahuje ObjectDisposedException výjimku ve Task.Exception vlastnosti.

Tato metoda ukládá do úlohy, která vrací všechny výjimky nesouvisejí s používáním, které může vyvolat synchronní protějšek metody. Pokud je ve vrácené úloze uložena výjimka, bude tato výjimka vyvolána při čekání na úkol. Výjimky použití, například ArgumentException, jsou stále vyvolány synchronně. Informace o uložených výjimkách najdete v tématu Výjimky vyvolané nástrojem Read(Byte[], Int32, Int32).

Viz také

Zrušení

Platí pro

Sdílet prostřednictvím

FileStream.ReadAsync Metoda

Definice

Přetížení

ReadAsync(Memory<Byte>, CancellationToken)

Parametry

Návraty

Výjimky

Příklady

Poznámky

Platí pro

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

Parametry

Návraty

Výjimky

Příklady

Poznámky

Viz také

Platí pro

Další materiály