Stream.ReadAsync Metodo

Riferimento

Definizione

Spazio dei nomi:: System.IO

Assembly:: System.Runtime.dll

Assembly:: netstandard.dll

Assembly:: System.IO.dll

Assembly:: mscorlib.dll

Importante

Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.

Legge in modo asincrono una sequenza di byte dal flusso corrente e passa alla posizione successiva nel flusso in base al numero di byte letti.

Overload

ReadAsync(Memory<Byte>, CancellationToken)	Legge in modo asincrono una sequenza di byte dal flusso corrente e passa alla posizione successiva all'interno del flusso corrente in base al numero di byte letti e monitora le richieste di annullamento.
ReadAsync(Byte[], Int32, Int32)	Legge in modo asincrono una sequenza di byte dal flusso corrente e passa alla posizione successiva nel flusso in base al numero di byte letti.
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Legge in modo asincrono una sequenza di byte dal flusso corrente e passa alla posizione successiva all'interno del flusso corrente in base al numero di byte letti e monitora le richieste di annullamento.

ReadAsync(Memory<Byte>, CancellationToken)

Origine:: Stream.cs

Origine:: Stream.cs

Origine:: Stream.cs

Legge in modo asincrono una sequenza di byte dal flusso corrente e passa alla posizione successiva all'interno del flusso corrente in base al numero di byte letti e monitora le richieste di annullamento.

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)

Parametri

buffer: Memory<Byte>

L'area di memoria su cui scrivere i dati.

cancellationToken: CancellationToken

Token da monitorare per le richieste di annullamento. Il valore predefinito è None.

Restituisce

ValueTask<Int32>

Attività che rappresenta l'operazione di lettura asincrona. Il valore della proprietà Result contiene il numero totale di byte letti nel buffer. Il valore del risultato può essere minore della lunghezza del buffer se tale numero di byte non è attualmente disponibile oppure può essere 0 (zero) se la lunghezza del buffer è 0 o se è stata raggiunta la fine del flusso.

Eccezioni

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

Il ReadAsync metodo consente di eseguire operazioni di I/O a elevato utilizzo di risorse senza bloccare il thread principale. Questa considerazione sulle prestazioni è particolarmente importante in un'app dello Store Windows 8.x o in un'app desktop in cui un'operazione di flusso che richiede molto tempo può bloccare il thread dell'interfaccia utente e rendere l'app come se non funzionasse. I metodi asincroni vengono usati insieme alle async parole chiave e await in Visual Basic e C#.

Utilizzare la CanRead proprietà per determinare se l'istanza corrente supporta la lettura.

Se l'operazione viene annullata prima del completamento, l'attività restituita contiene il TaskStatus.Canceled valore per la Status proprietà .

Per un esempio, vedere l'overload ReadAsync(Byte[], Int32, Int32) .

Si applica a

ReadAsync(Byte[], Int32, Int32)

Origine:: Stream.cs

Origine:: Stream.cs

Origine:: Stream.cs

Legge in modo asincrono una sequenza di byte dal flusso corrente e passa alla posizione successiva nel flusso in base al numero di byte letti.

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);

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

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

[<System.Runtime.InteropServices.ComVisible(false)>]
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)

Parametri

buffer: Byte[]

Buffer in cui scrivere i dati.

offset: Int32

Offset dei byte in buffer da cui iniziare la scrittura dei dati dal flusso.

count: Int32

Numero massimo di byte da leggere.

Restituisce

Task<Int32>

Attività che rappresenta l'operazione di lettura asincrona. Il valore del parametro di TResult contiene il numero totale di byte letti nel buffer. Il valore del risultato può essere minore del numero di byte richiesti se il numero di byte attualmente disponibili è minore del numero richiesto oppure può essere 0 (zero) se count è 0 o se è stata raggiunta la fine del flusso.

Attributi: ComVisibleAttribute

Eccezioni

ArgumentNullException

buffer è null.

ArgumentOutOfRangeException

offset o count è negativo.

ArgumentException

La somma di offset e count è maggiore della lunghezza del buffer.

NotSupportedException

Il flusso non supporta la lettura.

ObjectDisposedException

Il flusso è stato eliminato.

InvalidOperationException

Il flusso è attualmente usato da un'operazione di lettura precedente.

Esempio

Nell'esempio seguente viene illustrato come leggere da un file in modo asincrono. Nell'esempio viene utilizzata la FileStream classe , che deriva dalla Stream classe .

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

Commenti

Utilizzare la CanRead proprietà per determinare se l'istanza corrente supporta la lettura.

Questo metodo archivia nell'attività restituisce tutte le eccezioni non di utilizzo che la controparte sincrona del metodo può generare. Se un'eccezione viene archiviata nell'attività restituita, tale eccezione verrà generata quando l'attività è attesa. Le eccezioni di utilizzo, ad esempio ArgumentException, vengono comunque generate in modo sincrono. Per le eccezioni archiviate, vedere le eccezioni generate da Read(Byte[], Int32, Int32).

Si applica a

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

Origine:: Stream.cs

Origine:: Stream.cs

Origine:: Stream.cs

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);

[System.Runtime.InteropServices.ComVisible(false)]
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>

[<System.Runtime.InteropServices.ComVisible(false)>]
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)

Parametri

buffer: Byte[]

Buffer in cui scrivere i dati.

offset: Int32

Offset dei byte in buffer da cui iniziare la scrittura dei dati dal flusso.

count: Int32

Numero massimo di byte da leggere.

cancellationToken: CancellationToken

Token da monitorare per le richieste di annullamento. Il valore predefinito è None.

Restituisce

Task<Int32>

Attributi: ComVisibleAttribute

Eccezioni

ArgumentNullException

buffer è null.

ArgumentOutOfRangeException

offset o count è negativo.

ArgumentException

La somma di offset e count è maggiore della lunghezza del buffer.

NotSupportedException

Il flusso non supporta la lettura.

ObjectDisposedException

Il flusso è stato eliminato.

InvalidOperationException

Il flusso è attualmente usato da un'operazione di lettura precedente.

OperationCanceledException

Il token di annullamento è stato annullato. Questa eccezione viene archiviata nell'attività restituita.

Commenti

Utilizzare la CanRead proprietà per determinare se l'istanza corrente supporta la lettura.

Se l'operazione viene annullata prima del completamento, l'attività restituita contiene il Canceled valore per la Status proprietà .

Per un esempio, vedere l'overload ReadAsync(Byte[], Int32, Int32) .

Vedi anche

Annullamento

Si applica a

Condividi tramite

Stream.ReadAsync Metodo

Definizione

Overload

ReadAsync(Memory<Byte>, CancellationToken)

Parametri

Restituisce

Eccezioni

Commenti

Si applica a

ReadAsync(Byte[], Int32, Int32)

Parametri

Restituisce

Eccezioni

Esempio

Commenti

Si applica a

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

Parametri

Restituisce

Eccezioni

Commenti

Vedi anche

Si applica a

Risorse aggiuntive