Stream.ReadAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

以非同步的方式從目前的資料流讀取位元組序列，並依讀取的位元組數將資料流中的位置往前移。

多載

ReadAsync(Memory<Byte>, CancellationToken)	以非同步的方式從目前資料流讀取一連串的位元組、依所讀取的位元組數目進階資料流中的位置，以及監視取消要求。
ReadAsync(Byte[], Int32, Int32)	以非同步的方式從目前的資料流讀取位元組序列，並依讀取的位元組數將資料流中的位置往前移。
ReadAsync(Byte[], Int32, Int32, CancellationToken)	以非同步的方式從目前資料流讀取一連串的位元組、依所讀取的位元組數目進階資料流中的位置，以及監視取消要求。

ReadAsync(Memory<Byte>, CancellationToken)

以非同步的方式從目前資料流讀取一連串的位元組、依所讀取的位元組數目進階資料流中的位置，以及監視取消要求。

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)

參數

buffer

Memory<Byte>

要寫入資料的記憶體區域。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

ValueTask<Int32>

表示非同步讀取作業的工作。 其 Result 屬性值包含讀入緩衝區的位元組總數。 如果目前無法使用許多位元組，則結果值可以小於緩衝區的長度，或者如果緩衝區的長度為 0，則它可以是 0 (零) ，或者已到達資料流程的結尾。

例外狀況

OperationCanceledException

解除標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

方法 ReadAsync 可讓您執行耗用大量資源的 I/O 作業，而不會封鎖主執行緒。 這項效能考量對於 Windows 8.x Store 應用程式或傳統型應用程式而言特別重要，尤其是針對耗時的資料流作業可能會阻礙 UI 執行緒，使應用程式看起來像是停止運作的情況。 非同步方法會與 Visual Basic 和 C# 中的 和 await 關鍵字搭配 async 使用。

CanRead使用 屬性來判斷目前的實例是否支援讀取。

如果作業在完成之前取消，則傳回的工作會 TaskStatus.Canceled 包含 屬性的值 Status 。

如需範例，請參閱 ReadAsync(Byte[], Int32, Int32) 多載。

ReadAsync(Byte[], Int32, Int32)

以非同步的方式從目前的資料流讀取位元組序列，並依讀取的位元組數將資料流中的位置往前移。

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)

參數

buffer

Byte[]

寫入資料的緩衝區。

offset

Int32

開始於此處自資料流寫入資料的 buffer 中的位元組位移。

count

Int32

要讀取的最大位元組數。

傳回

Task<Int32>

表示非同步讀取作業的工作。 TResult 參數的值會包含讀取至緩衝區的位元組總數。 如果目前可用的位元組數目小於所要求的數位，則結果值可以小於要求的位元組數目，如果 為 0，則為 0 (零，如果 count 為 0，或已到達資料流程的結尾，則結果值可以是 0) 。

例外狀況

ArgumentNullException

buffer 為 null。

ArgumentOutOfRangeException

offset 或 count 為負。

ArgumentException

offset 和 count 的總和大於緩衝區長度。

NotSupportedException

資料流不支援讀取。

ObjectDisposedException

資料流已經處置。

InvalidOperationException

之前的讀取作業目前正在使用資料流。

範例

下列範例示範如何以非同步方式從檔案讀取。 此範例會 FileStream 使用 衍生自 類別的 Stream 類別。

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

備註

方法 ReadAsync 可讓您執行耗用大量資源的 I/O 作業，而不會封鎖主執行緒。 這項效能考量對於 Windows 8.x Store 應用程式或傳統型應用程式而言特別重要，尤其是針對耗時的資料流作業可能會阻礙 UI 執行緒，使應用程式看起來像是停止運作的情況。 非同步方法會與 Visual Basic 和 C# 中的 和 await 關鍵字搭配 async 使用。

CanRead使用 屬性來判斷目前的實例是否支援讀取。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 Read(Byte[], Int32, Int32) 例外狀況。

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

以非同步的方式從目前資料流讀取一連串的位元組、依所讀取的位元組數目進階資料流中的位置，以及監視取消要求。

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)

參數

buffer

Byte[]

寫入資料的緩衝區。

offset

Int32

開始於此處自資料流寫入資料的 buffer 中的位元組位移。

count

Int32

要讀取的最大位元組數。

cancellationToken

CancellationToken

用來監視是否有取消要求的語彙基元。 預設值是 None。

傳回

Task<Int32>

表示非同步讀取作業的工作。 TResult 參數的值會包含讀取至緩衝區的位元組總數。 如果目前可用的位元組數目小於所要求的數位，則結果值可以小於要求的位元組數目，如果 為 0，則為 0 (零，如果 count 為 0，或已到達資料流程的結尾，則結果值可以是 0) 。

例外狀況

ArgumentNullException

buffer 為 null。

ArgumentOutOfRangeException

offset 或 count 為負。

ArgumentException

offset 和 count 的總和大於緩衝區長度。

NotSupportedException

資料流不支援讀取。

ObjectDisposedException

資料流已經處置。

InvalidOperationException

之前的讀取作業目前正在使用資料流。

OperationCanceledException

解除標記已取消。 此例外狀況會儲存在傳回的工作中。

備註

方法 ReadAsync 可讓您執行耗用大量資源的 I/O 作業，而不會封鎖主執行緒。 這項效能考量對於 Windows 8.x Store 應用程式或傳統型應用程式而言特別重要，尤其是針對耗時的資料流作業可能會阻礙 UI 執行緒，使應用程式看起來像是停止運作的情況。 非同步方法會與 Visual Basic 和 C# 中的 和 await 關鍵字搭配 async 使用。

CanRead使用 屬性來判斷目前的實例是否支援讀取。

如果作業在完成之前取消，則傳回的工作會 Canceled 包含 屬性的值 Status 。

如需範例，請參閱 ReadAsync(Byte[], Int32, Int32) 多載。

這個方法會儲存在工作中，它會傳回方法同步對應專案可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException 仍會同步擲回。 如需預存例外狀況，請參閱 擲回的 Read(Byte[], Int32, Int32) 例外狀況。

另請參閱

• 取消