StringReader.ReadAsync Methode

Definition

Überlädt

ReadAsync(Memory<Char>, CancellationToken)
ReadAsync(Char[], Int32, Int32)

Liest eine angegebene Höchstanzahl von Zeichen asynchron aus der aktuellen Zeichenkette und schreibt die Daten in einen Puffer, wobei am angegebenen Index begonnen wird.Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

ReadAsync(Memory<Char>, CancellationToken)

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = null);
override this.ReadAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Parameter

buffer
Memory<Char>
cancellationToken
CancellationToken

Gibt zurück

ReadAsync(Char[], Int32, Int32)

Liest eine angegebene Höchstanzahl von Zeichen asynchron aus der aktuellen Zeichenkette und schreibt die Daten in einen Puffer, wobei am angegebenen Index begonnen wird.Reads a specified maximum number of characters from the current string asynchronously and writes the data to a buffer, beginning at the specified index.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <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>
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.When this method returns, contains the specified character array with the values between index and (index + count - 1) replaced by the characters read from the current source.

index
Int32

Die Position in buffer, an der mit dem Schreiben begonnen wird.The position in buffer at which to begin writing.

count
Int32

Die maximale Anzahl der zu lesenden Zeichen.The maximum number of characters to read. Wenn das Ende der Zeichenfolge erreicht ist, bevor die angegebene Anzahl von Zeichen in den Puffer geschrieben wurde, erfolgt die Methodenrückgabe.If the end of the string is reached before the specified number of characters is written into the buffer, the method returns.

Gibt zurück

Eine Aufgabe, die den asynchronen Lesevorgang darstellt.A task that represents the asynchronous read operation. Der Wert des TResult-Parameters enthält die Gesamtzahl der Bytes, die in den Puffer gelesen werden.The value of the TResult parameter contains the total number of bytes read into the buffer. Der Ergebniswert kann niedriger als die Anzahl der angeforderten Bytes sein, wenn die Anzahl an derzeit verfügbaren Bytes kleiner ist als die angeforderte Anzahl, oder sie kann 0 (null) sein, wenn das Zeichenfolgenende erreicht ist.The result value can be less than the number of bytes requested if the number of bytes currently available is less than the requested number, or it can be 0 (zero) if the end of the string has been reached.

Attribute

Ausnahmen

buffer ist null.buffer is null.

index oder count ist ein negativer Wert.index or count is negative.

Die Summe aus index und count ist größer als die Pufferlänge.The sum of index and count is larger than the buffer length.

Der Zeichenfolgen-Reader wurde freigegeben.The string reader has been disposed.

Der Reader wird zurzeit von einem vorherigen Lesevorgang verwendet.The reader is currently in use by a previous read operation.

Beispiele

Im folgenden Beispiel wird gezeigt, wie die ersten 23 Zeichen einer Zeichenfolge asynchron gelesen werden.The following example shows how to read the first 23 characters of a string asynchronously.

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

Die Aufgabe wird abgeschlossen, nachdem entweder die Anzahl der durch den count -Parameter angegebenen Zeichen gelesen oder das Ende der Zeichenfolge erreicht wurde.The task completes after either the number of characters specified by the count parameter are read or the end of the string is reached.

Gilt für: