Stream.ReadAsync Metódus

Definíció

Névtér:

System.IO

Szerelvények:

netstandard.dll, System.Runtime.dll

Aszinkron módon beolvassa az aktuális adatfolyamból származó bájtok sorozatát, és az olvasási bájtok számával előrelépteti a streamen belüli pozíciót.

Túlterhelések

Name	Description
ReadAsync(Memory<Byte>, CancellationToken)	Aszinkron módon beolvassa a bájtok sorozatát az aktuális adatfolyamból, az olvasási bájtok számával előrelép a streamben, és figyeli a lemondási kérelmeket.
ReadAsync(Byte[], Int32, Int32)	Aszinkron módon beolvassa az aktuális adatfolyamból származó bájtok sorozatát, és az olvasási bájtok számával előrelépteti a streamen belüli pozíciót.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Aszinkron módon beolvassa a bájtok sorozatát az aktuális adatfolyamból, az olvasási bájtok számával előrelép a streamben, és figyeli a lemondási kérelmeket.

ReadAsync(Memory<Byte>, CancellationToken)

Forrás:

Stream.cs

Aszinkron módon beolvassa a bájtok sorozatát az aktuális adatfolyamból, az olvasási bájtok számával előrelép a streamben, és figyeli a lemondási kérelmeket.

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

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

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

Paraméterek

buffer

Memory<Byte>

Az adatok írásához használandó memóriaterület.

cancellationToken

CancellationToken

A lemondási kérelmek figyelésére szolgáló jogkivonat. Az alapértelmezett érték a None.

Válaszok

ValueTask<Int32>

Az aszinkron olvasási műveletet képviselő feladat. A tulajdonság értéke Result a pufferbe beolvasott bájtok teljes számát tartalmazza. Az eredmény értéke kisebb lehet a puffer hosszánál, ha jelenleg nem érhető el több bájt, vagy 0 (nulla) lehet, ha a puffer hossza 0, vagy ha elérte a stream végét.

Kivételek

OperationCanceledException

A lemondási jogkivonat megszakadt. Ezt a kivételt a rendszer a visszaadott tevékenységben tárolja.

Megjegyzések

A ReadAsync módszer lehetővé teszi az erőforrás-igényes I/O-műveletek végrehajtását a fő szál blokkolása nélkül. Ez a teljesítménybeli szempont különösen fontos egy Windows 8.x Áruházbeli vagy asztali alkalmazásban, ahol egy időigényes streamelési művelet blokkolhatja a felhasználói felületi szálat, és úgy jelenik meg, mintha az alkalmazás nem működna. Az aszinkron metódusok a async és await kulcsszavakkal együtt használatosak Visual Basic és C# nyelven.

CanRead A tulajdonság használatával állapítsa meg, hogy az aktuális példány támogatja-e az olvasást.

Ha a művelet befejeződése előtt megszakítja a műveletet, a visszaadott tevékenység tartalmazza a TaskStatus.CanceledStatus tulajdonság értékét.

Például tekintse meg a túlterhelést ReadAsync(Byte[], Int32, Int32) .

ReadAsync(Byte[], Int32, Int32)

Forrás:

Stream.cs

Aszinkron módon beolvassa az aktuális adatfolyamból származó bájtok sorozatát, és az olvasási bájtok számával előrelépteti a streamen belüli pozíciót.

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

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

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

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

Paraméterek

buffer

Byte[]

A puffer, amelybe beírja az adatokat.

offset

Int32

A bájteltolódás buffer , amelynél megkezdheti az adatok írását a streamből.

count

Int32

Az elolvasandó bájtok maximális száma.

Válaszok

Task<Int32>

Az aszinkron olvasási műveletet képviselő feladat. A paraméter értéke a TResult pufferbe beolvasott bájtok teljes számát tartalmazza. Az eredmény értéke kisebb lehet, mint a kért bájtok száma, ha a jelenleg elérhető bájtok száma kisebb a kért számnál, vagy 0 (nulla) lehet, ha count 0, vagy ha a stream vége el lett érve.

Kivételek

ArgumentNullException

buffer az null.

ArgumentOutOfRangeException

offset vagy count negatív.

ArgumentException

A puffer hosszánál nagyobb és offset nagyobb összegcount.

NotSupportedException

A stream nem támogatja az olvasást.

ObjectDisposedException

A stream el lett dobva.

InvalidOperationException

A streamet jelenleg egy korábbi olvasási művelet használja.

Példák

Az alábbi példa bemutatja, hogyan lehet aszinkron módon olvasni egy fájlból. A példa az FileStream osztályból Stream származó osztályt használja.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            string filename = @"c:\Temp\userinputlog.txt";
            byte[] result;

            using (FileStream SourceStream = File.Open(filename, FileMode.Open))
            {
                result = new byte[SourceStream.Length];
                await SourceStream.ReadAsync(result, 0, (int)SourceStream.Length);
            }

            UserInput.Text = System.Text.Encoding.ASCII.GetString(result);
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "c:\Temp\userinputlog.txt"

        Dim result As Byte()

        Using SourceStream As FileStream = File.Open(filename, FileMode.Open)
            result = New Byte(SourceStream.Length - 1) {}
            Await SourceStream.ReadAsync(result, 0, CType(SourceStream.Length, Integer))
        End Using

        UserInput.Text = System.Text.Encoding.ASCII.GetString(result)
    End Sub
End Class

Megjegyzések

A ReadAsync módszer lehetővé teszi az erőforrás-igényes I/O-műveletek végrehajtását a fő szál blokkolása nélkül. Ez a teljesítménybeli szempont különösen fontos egy Windows 8.x Áruházbeli vagy asztali alkalmazásban, ahol egy időigényes streamelési művelet blokkolhatja a felhasználói felületi szálat, és úgy jelenik meg, mintha az alkalmazás nem működna. Az aszinkron metódusok a async és await kulcsszavakkal együtt használatosak Visual Basic és C# nyelven.

CanRead A tulajdonság használatával állapítsa meg, hogy az aktuális példány támogatja-e az olvasást.

Ez a metódus a feladatban tárolja az összes olyan nem használati kivételt, amelyet a metódus szinkron megfelelője tud dobni. Ha egy kivételt tárol a visszaadott tevékenységben, akkor a rendszer akkor küldi el a kivételt, amikor a feladatra vár. A használati kivételek(például ArgumentException) továbbra is szinkron módon jelennek meg. A tárolt kivételekről lásd a következő által Read(Byte[], Int32, Int32)kiadott kivételeket: .

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

Forrás:

Stream.cs

Aszinkron módon beolvassa a bájtok sorozatát az aktuális adatfolyamból, az olvasási bájtok számával előrelép a streamben, és figyeli a lemondási kérelmeket.

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

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

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

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

Paraméterek

buffer

Byte[]

A puffer, amelybe beírja az adatokat.

offset

Int32

A bájteltolódás buffer , amelynél megkezdheti az adatok írását a streamből.

count

Int32

Az elolvasandó bájtok maximális száma.

cancellationToken

CancellationToken

A lemondási kérelmek figyelésére szolgáló jogkivonat. Az alapértelmezett érték a None.

Válaszok

Task<Int32>

Az aszinkron olvasási műveletet képviselő feladat. A paraméter értéke a TResult pufferbe beolvasott bájtok teljes számát tartalmazza. Az eredmény értéke kisebb lehet, mint a kért bájtok száma, ha a jelenleg elérhető bájtok száma kisebb a kért számnál, vagy 0 (nulla) lehet, ha count 0, vagy ha a stream vége el lett érve.

Kivételek

ArgumentNullException

buffer az null.

ArgumentOutOfRangeException

offset vagy count negatív.

ArgumentException

A puffer hosszánál nagyobb és offset nagyobb összegcount.

NotSupportedException

A stream nem támogatja az olvasást.

ObjectDisposedException

A stream el lett dobva.

InvalidOperationException

A streamet jelenleg egy korábbi olvasási művelet használja.

OperationCanceledException

A lemondási jogkivonat megszakadt. Ezt a kivételt a rendszer a visszaadott tevékenységben tárolja.

Megjegyzések

A ReadAsync módszer lehetővé teszi az erőforrás-igényes I/O-műveletek végrehajtását a fő szál blokkolása nélkül. Ez a teljesítménybeli szempont különösen fontos egy Windows 8.x Áruházbeli vagy asztali alkalmazásban, ahol egy időigényes streamelési művelet blokkolhatja a felhasználói felületi szálat, és úgy jelenik meg, mintha az alkalmazás nem működna. Az aszinkron metódusok a async és await kulcsszavakkal együtt használatosak Visual Basic és C# nyelven.

CanRead A tulajdonság használatával állapítsa meg, hogy az aktuális példány támogatja-e az olvasást.

Ha a művelet befejeződése előtt megszakítja a műveletet, a visszaadott tevékenység tartalmazza a CanceledStatus tulajdonság értékét.

Például tekintse meg a túlterhelést ReadAsync(Byte[], Int32, Int32) .

Ez a metódus a feladatban tárolja az összes olyan nem használati kivételt, amelyet a metódus szinkron megfelelője tud dobni. Ha egy kivételt tárol a visszaadott tevékenységben, akkor a rendszer akkor küldi el a kivételt, amikor a feladatra vár. A használati kivételek(például ArgumentException) továbbra is szinkron módon jelennek meg. A tárolt kivételekről lásd a következő által Read(Byte[], Int32, Int32)kiadott kivételeket: .

Lásd még

• lemondás