TextReader.ReadBlockAsync Methode

Definition

Namespace:
System.IO
Assembly:
System.Runtime.dll
Assembly:
System.Runtime.Extensions.dll
Assembly:
netstandard.dll
Assembly:
System.IO.dll
Assembly:
mscorlib.dll

Überlädt

ReadBlockAsync(Memory<Char>, CancellationToken)

Liest die Zeichen aus dem aktuellen Datenstrom asynchron und schreibt die Daten in einen Puffer.Asynchronously reads the characters from the current stream and writes the data to a buffer.
ReadBlockAsync(Char[], Int32, Int32)

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

ReadBlockAsync(Memory<Char>, CancellationToken)

Liest die Zeichen aus dem aktuellen Datenstrom asynchron und schreibt die Daten in einen Puffer.Asynchronously reads the characters from the current stream and writes the data to a buffer.

public virtual System.Threading.Tasks.ValueTask<int> ReadBlockAsync (Memory<char> buffer, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
override this.ReadBlockAsync : Memory<char> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>
Public Overridable Function ReadBlockAsync (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 wurdeWhen this method returns, contains the specified memory block of characters replaced by the characters read from the current source.

cancellationToken
CancellationToken

Das Token zum Überwachen von Abbruchanforderungen.The token to monitor for cancellation requests. Der Standardwert ist None.The default value is None.

Gibt zurück

ValueTask<Int32>

Ein Werttask, der den asynchronen Lesevorgang darstelltA value task that represents the asynchronous read operation. Der Wert des Typparameters enthält die Gesamtzahl der Zeichen, die in den Puffer gelesen werden.The value of the type parameter contains the total number of characters read into the buffer. 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.The result value can be less than the number of characters requested if the number of characters currently available is less than the requested number, or it can be 0 (zero) if the end of the stream has been reached.

Gilt für:

ReadBlockAsync(Char[], Int32, Int32)

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

public:
 virtual System::Threading::Tasks::Task<int> ^ ReadBlockAsync(cli::array <char> ^ buffer, int index, int count);
public virtual System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);
[System.Runtime.InteropServices.ComVisible(false)]
public virtual System.Threading.Tasks.Task<int> ReadBlockAsync (char[] buffer, int index, int count);
abstract member ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
override this.ReadBlockAsync : char[] * int * int -> System.Threading.Tasks.Task<int>
Public Overridable Function ReadBlockAsync (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 des Texts erreicht ist, bevor die angegebene Anzahl von Zeichen in den Puffer gelesen wurde, erfolgt die aktuelle Methodenrückgabe.If the end of the text is reached before the specified number of characters is read into the buffer, the current method returns.

Gibt zurück

Task<Int32>

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 Textende 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 text has been reached.

Attribute
ComVisibleAttribute

Ausnahmen

ArgumentNullException

buffer ist null.buffer is null.

ArgumentOutOfRangeException

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

ArgumentException

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

ObjectDisposedException

Der Textreader wurde freigegeben.The text reader has been disposed.

InvalidOperationException

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

Hinweise

Der Task wird erst abgeschlossen, wenn entweder die durch den-Parameter angegebene Anzahl von Zeichen count gelesen oder das Ende des Texts erreicht wurde.The task does not complete until either the number of characters specified by the count parameter are read, or the end of the text has been reached.

Siehe auch

Gilt für: