StreamReader.ReadAsync Methode

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Überlädt

ReadAsync(Memory<Char>, CancellationToken)	Liest die Zeichen asynchron aus dem aktuellen Datenstrom in einen Speicherblock.
ReadAsync(Char[], Int32, Int32)	Liest eine angegebene Höchstanzahl von Zeichen asynchron aus dem aktuellen Stream und schreibt die Daten in einen Puffer, wobei am angegebenen Index begonnen wird.

ReadAsync(Memory<Char>, CancellationToken)

Quelle:

StreamReader.cs

Liest die Zeichen asynchron aus dem aktuellen Datenstrom 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>

Enthält nach dem Beenden dieser Methode den angegebene Speicherblock, der durch die aus der aktuellen Quelle gelesenen Zeichen ersetzt wurde

cancellationToken

CancellationToken

Das Token zum Überwachen von Abbruchanforderungen. Der Standardwert ist None.

Gibt zurück

ValueTask<Int32>

Ein Werttask, der den asynchronen Lesevorgang darstellt Der Wert des Typparameters des Werttasks enthält die Anzahl der gelesenen Zeichen bzw. 0 (null), wenn das Ende des Datenstroms erreicht ist und keine Daten gelesen wurden. Die Anzahl ist kleiner oder gleich der buffer-Länge, abhängig davon, ob die Daten im Datenstrom verfügbar sind.

Ausnahmen

OperationCanceledException

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

ReadAsync(Char[], Int32, Int32)

Quelle:

StreamReader.cs

Liest eine angegebene Höchstanzahl von Zeichen asynchron aus dem aktuellen Stream und schreibt die Daten in einen Puffer, wobei am angegebenen Index begonnen wird.

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

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

Enthält nach der Rückgabe dieser Methode das angegebene Zeichenarray mit den Werten zwischen index und (index + count - 1), die durch die aus der aktuellen Quelle gelesenen Zeichen ersetzt wurden.

index

Int32

Die Position in buffer, an der mit dem Schreiben begonnen wird.

count

Int32

Die maximale Anzahl der zu lesenden Zeichen. Wenn das Ende des Streams erreicht ist, bevor die angegebene Anzahl von Zeichen in den Puffer geschrieben wurde, erfolgt die aktuelle Methodenrückgabe.

Gibt zurück

Task<Int32>

Eine Aufgabe, die den asynchronen Lesevorgang darstellt. Der Wert des TResult-Parameters enthält die Gesamtzahl der Zeichen, die in den Puffer gelesen werden. Der Ergebniswert kann kleiner als die Anzahl der angeforderten Zeichen sein, wenn die Anzahl der derzeit verfügbaren Zeichen kleiner ist als die angeforderte Anzahl, oder er kann 0 (null) sein, wenn das Datenstromende erreicht ist.

Ausnahmen

ArgumentNullException

buffer ist null.

ArgumentOutOfRangeException

index oder count ist ein negativer Wert.

ArgumentException

Die Summe von index und count ist größer als die Pufferlänge.

ObjectDisposedException

Der Stream wurde verworfen.

InvalidOperationException

Der Reader wird zurzeit von einem vorherigen Lesevorgang verwendet.

Beispiele

Im folgenden Beispiel wird gezeigt, wie alle Zeichen in einer Datei mithilfe der ReadAsync(Char[], Int32, Int32) -Methode gelesen werden. Es überprüft, ob jedes Zeichen ein Buchstabe, eine Ziffer oder ein Leerzeichen ist, bevor das Zeichen einem instance 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 vom count Parameter angegebene Anzahl von Zeichen gelesen oder das Ende des Datenstroms erreicht wurde.

Diese Methode speichert in der Aufgabe, die alle Nichtverwendungsausnahmen zurückgibt, die die synchrone Entsprechung 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 wie ArgumentExceptionwerden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie unter ausnahmen, die von ausgelöst werden Read(Char[], Int32, Int32).