StreamReader.ReadAsync Methode

Definition

Überlädt

Name Beschreibung
ReadAsync(Memory<Char>, CancellationToken)

Liest die Zeichen aus dem aktuellen Datenstrom asynchron in einen Speicherblock.

ReadAsync(Char[], Int32, Int32)

Liest eine angegebene maximale Anzahl von Zeichen aus dem aktuellen Datenstrom asynchron und schreibt die Daten in einen Puffer, beginnend am angegebenen Index.

ReadAsync(Memory<Char>, CancellationToken)

Liest die Zeichen aus dem aktuellen Datenstrom asynchron in einen Speicherblock.

public override System.Threading.Tasks.ValueTask<int> ReadAsync(Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overrides Function ReadAsync (buffer As Memory(Of Char), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parameter

buffer
Memory<Char>

Wenn diese Methode zurückgegeben wird, enthält sie den angegebenen Speicherblock von Zeichen, der durch die aus der aktuellen Quelle gelesenen Zeichen ersetzt wird.

cancellationToken
CancellationToken

Das Token, das auf Abbruchanforderungen überwacht werden soll. Der Standardwert ist None.

Gibt zurück

Eine Wertaufgabe, die den asynchronen Lesevorgang darstellt. Der Wert des Typparameters der Wertaufgabe enthält die Anzahl der Zeichen, die gelesen wurden, oder 0, wenn am Ende des Datenstroms und keine Daten gelesen wurden. Die Zahl ist kleiner oder gleich der buffer Länge, je nachdem, ob die Daten im Datenstrom verfügbar sind.

Ausnahmen

Das Abbruchtoken wurde abgebrochen. Diese Ausnahme wird in der zurückgegebenen Aufgabe gespeichert.

Gilt für:

ReadAsync(Char[], Int32, Int32)

Liest eine angegebene maximale Anzahl von Zeichen aus dem aktuellen Datenstrom asynchron und schreibt die Daten in einen Puffer, beginnend am angegebenen Index.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);
public override System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public override System.Threading.Tasks.Task<int> ReadAsync(char[] buffer, int index, int count);
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
override this.ReadAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overrides Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

Parameter

buffer
Char[]

Wenn diese Methode zurückgegeben wird, enthält sie das angegebene Zeichenarray mit den Werten zwischen index und (index + count - 1), die durch die aus der aktuellen Quelle gelesenen Zeichen ersetzt werden.

index
Int32

Die Position, an buffer der mit dem Schreiben begonnen werden soll.

count
Int32

Die maximale Anzahl zu lesenden Zeichen. Wenn das Ende des Datenstroms erreicht ist, bevor die angegebene Anzahl von Zeichen in den Puffer geschrieben wird, gibt die aktuelle Methode zurück.

Gibt zurück

Eine Aufgabe, die den asynchronen Lesevorgang darstellt. Der Wert des TResult Parameters enthält die Gesamtanzahl der zeichen, die in den Puffer gelesen werden. Der Ergebniswert kann kleiner als die Anzahl der angeforderten Zeichen sein, wenn die Anzahl der zurzeit verfügbaren Zeichen kleiner als die angeforderte Zahl ist, oder es kann 0 (Null) sein, wenn das Ende des Datenstroms erreicht wurde.

Attribute

Ausnahmen

buffer ist null.

index oder count ist negativ.

Die Summe und indexcount ist größer als die Pufferlänge.

Der Datenstrom wurde gelöscht.

Der Leser wird derzeit von einem vorherigen Lesevorgang verwendet.

Beispiele

Das folgende Beispiel zeigt, wie alle Zeichen in einer Datei mithilfe der ReadAsync(Char[], Int32, Int32) Methode gelesen werden. Sie überprüft, ob jedes Zeichen ein Buchstabe, eine Ziffer oder ein Leerzeichen ist, bevor es einer Instanz der StringBuilder Klasse hinzugefügt wird.

using System;
using System.Windows;
using System.IO;
using System.Text;

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

        private async void Button_Click_1(object sender, RoutedEventArgs e)
        {
            string filename = @"C:\Example\existingfile.txt";
            char[] result;
            StringBuilder builder = new StringBuilder();

            using (StreamReader reader = File.OpenText(filename))
            {
                result = new char[reader.BaseStream.Length];
                await reader.ReadAsync(result, 0, (int)reader.BaseStream.Length);
            }

            foreach (char c in result)
            {
                if (char.IsLetterOrDigit(c) || char.IsWhiteSpace(c))
                {
                    builder.Append(c);
                }
            }
            FileOutput.Text = builder.ToString();
        }
    }
}
Imports System.Text
Imports System.IO

Class MainWindow

    Private Async Sub Button_Click_1(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "C:\Example\existingfile.txt"
        Dim result() As Char
        Dim builder As StringBuilder = New StringBuilder()

        Using reader As StreamReader = File.OpenText(filename)
            ReDim result(reader.BaseStream.Length)
            Await reader.ReadAsync(result, 0, reader.BaseStream.Length)
        End Using

        For Each c As Char In result
            If (Char.IsLetterOrDigit(c) Or Char.IsWhiteSpace(c)) Then
                builder.Append(c)
            End If
            Next
        FileOutput.Text = builder.ToString()
    End Sub
End Class

Hinweise

Die Aufgabe wird abgeschlossen, nachdem entweder die Anzahl der durch den count Parameter angegebenen Zeichen gelesen wurde oder das Ende des Datenstroms erreicht ist.

Diese Methode speichert in der Aufgabe, die alle Nicht-Verwendungs-Ausnahmen zurückgibt, die das synchrone Gegenstück der Methode auslösen kann. Wenn eine Ausnahme in der zurückgegebenen Aufgabe gespeichert wird, wird diese Ausnahme ausgelöst, wenn die Aufgabe erwartet wird. Verwendungsausnahmen, z. B. ArgumentException, werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie in den von Read(Char[], Int32, Int32).

Gilt für: