StringReader.ReadAsync Methode

Definition

Namespace:
System.IO
Assembly:
netstandard.dll
Assemblys:
mscorlib.dll, System.IO.dll
Assembly:
mscorlib.dll
Assembly:
System.IO.dll

Überlädt

Name Beschreibung
ReadAsync(Memory<Char>, CancellationToken)

Liest asynchron alle Zeichen aus der Eingabezeichenfolge ab der aktuellen Position und wechselt zur aktuellen Position zum Ende der Eingabezeichenfolge.
ReadAsync(Char[], Int32, Int32)

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

ReadAsync(Memory<Char>, CancellationToken)

Liest asynchron alle Zeichen aus der Eingabezeichenfolge ab der aktuellen Position und wechselt zur aktuellen Position zum Ende der Eingabezeichenfolge.

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 die Zeichen, die aus der aktuellen Quelle gelesen werden.

cancellationToken
CancellationToken

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

Gibt zurück

ValueTask<Int32>

Eine Aufgabe, die den asynchronen Lesevorgang darstellt. Der Wert des TResult Parameters enthält die Gesamtanzahl der zeichen, die in den Puffer gelesen werden.

Ausnahmen

OperationCanceledException

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 der aktuellen Zeichenfolge 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 der Zeichenfolge erreicht ist, bevor die angegebene Anzahl von Zeichen in den Puffer geschrieben wird, gibt die Methode zurück.

Gibt zurück

Task<Int32>

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

Attribute
ComVisibleAttribute

Ausnahmen

ArgumentNullException

buffer ist null.

ArgumentOutOfRangeException

index oder count ist negativ.

ArgumentException

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

ObjectDisposedException

Der Zeichenfolgenleser wurde verworfen.

InvalidOperationException

Der Leser wird derzeit von einem vorherigen Lesevorgang verwendet.

Beispiele

Das folgende Beispiel zeigt, wie die ersten 23 Zeichen einer Zeichenfolge asynchron gelesen werden.

using System;
using System.IO;

namespace ConsoleApplication
{
    class Program
    {
        static void Main(string[] args)
        {
            ReadCharacters();
        }

        static async void ReadCharacters()
        {
            string stringToRead = "Some characters to read but not all";
            char[] charsRead = new char[stringToRead.Length];

            using (StringReader reader = new StringReader(stringToRead))
            {
                await reader.ReadAsync(charsRead, 0, 23);
                Console.WriteLine(charsRead);
            }
        }
    }
}
// The example displays the following output:
// Some characters to read
//

Imports System.IO

Module Module1

    Sub Main()
        ReadCharacters()
    End Sub

    Async Sub ReadCharacters()
        Dim stringToRead = "Some characters to read but not all"
        Dim charsRead(stringToRead.Length) As Char

        Using reader As StringReader = New StringReader(stringToRead)
            Await reader.ReadAsync(charsRead, 0, 23)
            Console.WriteLine(charsRead)
        End Using
    End Sub

End Module
' The example displays the following output:
' Some characters to read
'

Hinweise

Der Vorgang wird abgeschlossen, nachdem die Anzahl der durch den count Parameter angegebenen Zeichen gelesen wurde oder das Ende der Zeichenfolge 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: