BufferedStream.ReadAsync Methode

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Überlädt

ReadAsync(Memory<Byte>, CancellationToken)	Liest eine Bytesequenz asynchron aus dem aktuellen gepufferten Stream und setzt die Position in diesem gepufferten Stream um die Anzahl der gelesenen Bytes nach vorn.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Liest eine Folge von Bytes asynchron aus aktuellen Stream, erhöht die Position im Stream um die Anzahl der gelesenen Bytes und überwacht Abbruchanfragen.

ReadAsync(Memory<Byte>, CancellationToken)

Quelle:

BufferedStream.cs

Liest eine Bytesequenz asynchron aus dem aktuellen gepufferten Stream und setzt die Position in diesem gepufferten Stream um die Anzahl der gelesenen Bytes nach vorn.

public override System.Threading.Tasks.ValueTask<int> ReadAsync (Memory<byte> buffer, System.Threading.CancellationToken cancellationToken = default);

override this.ReadAsync : Memory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<int>

Public Overrides Function ReadAsync (buffer As Memory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Integer)

Parameter

buffer

Memory<Byte>

Der Bereich im Arbeitsspeicher, in den die Daten geschrieben werden sollen.

cancellationToken

CancellationToken

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

Gibt zurück

ValueTask<Int32>

Eine Aufgabe, die den asynchronen Lesevorgang darstellt. Der Wert seiner Result-Eigenschaft enthält die Gesamtzahl der Bytes, die in den Puffer gelesen werden. Der Ergebniswert kann weniger als die Anzahl der im Puffer zugeordneten Bytes sein, wenn diese Anzahl an Bytes derzeit nicht verfügbar ist, oder er kann 0 (null) sein, wenn das Ende des Streams erreicht ist.

Ausnahmen

OperationCanceledException

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

Hinweise

Mit ReadAsync der -Methode können Sie ressourcenintensive E/A-Vorgänge ausführen, ohne den Standard Thread zu blockieren. Diese Überlegungen zur Leistung sind insbesondere in einer Windows 8.x Store-App oder Desktop-App wichtig, bei der ein zeitaufwendiger Streamingvorgang den UI-Thread blockieren kann und es dann den Anschein hat, dass Ihre App nicht funktioniert. Die asynchronen Methoden werden in Verbindung mit den async Schlüsselwörtern und await in Visual Basic und C# verwendet.

Verwenden Sie die CanRead -Eigenschaft, um zu bestimmen, ob die aktuelle instance Lesevorgänge unterstützt.

Wenn der Vorgang vor Abschluss abgebrochen wird, enthält die zurückgegebene Aufgabe den TaskStatus.Canceled Wert für die Status Eigenschaft.

ReadAsync(Byte[], Int32, Int32, CancellationToken)

Quelle:

BufferedStream.cs

Liest eine Folge von Bytes asynchron aus aktuellen Stream, erhöht die Position im Stream um die Anzahl der gelesenen Bytes und überwacht Abbruchanfragen.

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <System::Byte> ^ buffer, int offset, int count, System::Threading::CancellationToken cancellationToken);

public override System.Threading.Tasks.Task<int> ReadAsync (byte[] buffer, int offset, int count, System.Threading.CancellationToken cancellationToken);

override this.ReadAsync : byte[] * int * int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<int>

Public Overrides Function ReadAsync (buffer As Byte(), offset As Integer, count As Integer, cancellationToken As CancellationToken) As Task(Of Integer)

Parameter

buffer

Byte[]

Der Puffer, in den die Daten geschrieben werden sollen.

offset

Int32

Der Byteoffset im buffer, ab dem Daten aus dem Stream geschrieben werden.

count

Int32

Die maximale Anzahl der zu lesenden Bytes.

cancellationToken

CancellationToken

Das Token zum Überwachen von Abbruchanforderungen.

Gibt zurück

Task<Int32>

Eine Aufgabe, die den asynchronen Lesevorgang darstellt. Der Wert des TResult-Parameters enthält die Gesamtzahl der Bytes, die in den Puffer gelesen werden. 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 Datenstromende erreicht ist.

Ausnahmen

ArgumentNullException

buffer ist null.

ArgumentOutOfRangeException

offset oder count ist ein negativer Wert.

ArgumentException

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

NotSupportedException

Lesevorgänge werden vom Stream nicht unterstützt.

ObjectDisposedException

Der Stream wurde verworfen.

InvalidOperationException

Der Stream wird zurzeit von einem vorherigen Lesevorgang verwendet.

OperationCanceledException

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

Hinweise

Sie können ein Abbruchtoken erstellen, indem Sie eine instance der CancellationTokenSource -Klasse erstellen und die Token -Eigenschaft als cancellationToken Parameter übergeben.

Diese Methode speichert in der Aufgabe, die sie 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. Nutzungsausnahmen, z. B ArgumentException. , werden weiterhin synchron ausgelöst. Informationen zu den gespeicherten Ausnahmen finden Sie unter die von ausgelösten Read(Byte[], Int32, Int32)Ausnahmen.