StreamReader.ReadAsync 方法

定義

命名空間:

System.IO

組件:

System.Runtime.dll

多載

ReadAsync(Memory<Char>, CancellationToken)	以非同步方式將目前資料流中的字元讀入至記憶體區塊。
ReadAsync(Char[], Int32, Int32)	從目前的資料流非同步讀取指定的取大字元數目，並從指定的索引開始將資料寫入緩衝區。

ReadAsync(Memory<Char>, CancellationToken)

來源:

StreamReader.cs

以非同步方式將目前資料流中的字元讀入至記憶體區塊。

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

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

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

參數

buffer

Memory<Char>

當這個方法傳回時，會包含讀取自目前來源之字元所取代的指定字元記憶體區塊。

cancellationToken

CancellationToken

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

傳回

ValueTask<Int32>

代表非同步讀取作業的值工作。 值工作型別參數值包含已讀取的字元數；若處於資料流結尾且未讀取任何資料，則為 0。 取決於是否可在資料流中使用資料，數目會小於或等於 buffer 的長度。

例外狀況

OperationCanceledException

取消權杖已取消。 此例外狀況會儲存在傳回的工作中。

ReadAsync(Char[], Int32, Int32)

來源:

StreamReader.cs

從目前的資料流非同步讀取指定的取大字元數目，並從指定的索引開始將資料寫入緩衝區。

public:
 override System::Threading::Tasks::Task<int> ^ ReadAsync(cli::array <char> ^ buffer, int index, int count);

public override System.Threading.Tasks.Task<int> ReadAsync (char[] buffer, int index, int count);

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

Public Overrides Function ReadAsync (buffer As Char(), index As Integer, count As Integer) As Task(Of Integer)

參數

buffer

Char[]

當這個方法傳回時，會包含指定的字元陣列，這個陣列具有介於 index 到 (index + count - 1) 之間的值，已由讀取自目前來源的字元所取代。

index

Int32

buffer 中要開始寫入的位置。

count

Int32

要讀取的字元數上限。 如果指定的字元數寫入緩衝區之前，便到達資料流末端，則目前的方法會傳回。

傳回

Task<Int32>

表示非同步讀取作業的工作。 TResult 參數的值會包含讀入緩衝區的字元總數。 如果目前可供使用的字元數目少於所要求的數目，結果值可能會小於所要求的字元數目，或者如果已經到達資料流末端，則可能為 0 (零)。

例外狀況

ArgumentNullException

buffer 為 null。

ArgumentOutOfRangeException

index 或 count 為負。

ArgumentException

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

ObjectDisposedException

資料流已經處置。

InvalidOperationException

之前的讀取作業目前正在使用讀取器。

範例

下列範例示範如何使用 方法來讀取檔案 ReadAsync(Char[], Int32, Int32) 中的所有字元。 它會先檢查每個字元是否為字母、數位或空白字元，再將字元新增至 類別的 StringBuilder 實例。

using System;
using System.Windows;
using System.IO;
using System.Text;

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

        private async void Button_Click_1(object sender, RoutedEventArgs e)
        {
            string filename = @"C:\Example\existingfile.txt";
            char[] result;
            StringBuilder builder = new StringBuilder();

            using (StreamReader reader = File.OpenText(filename))
            {
                result = new char[reader.BaseStream.Length];
                await reader.ReadAsync(result, 0, (int)reader.BaseStream.Length);
            }

            foreach (char c in result)
            {
                if (char.IsLetterOrDigit(c) || char.IsWhiteSpace(c))
                {
                    builder.Append(c);
                }
            }
            FileOutput.Text = builder.ToString();
        }
    }
}

Imports System.Text
Imports System.IO

Class MainWindow

    Private Async Sub Button_Click_1(sender As Object, e As RoutedEventArgs)
        Dim filename As String = "C:\Example\existingfile.txt"
        Dim result() As Char
        Dim builder As StringBuilder = New StringBuilder()

        Using reader As StreamReader = File.OpenText(filename)
            ReDim result(reader.BaseStream.Length)
            Await reader.ReadAsync(result, 0, reader.BaseStream.Length)
        End Using

        For Each c As Char In result
            If (Char.IsLetterOrDigit(c) Or Char.IsWhiteSpace(c)) Then
                builder.Append(c)
            End If
            Next
        FileOutput.Text = builder.ToString()
    End Sub
End Class

備註

工作會在讀取 參數指定的 count 字元數或到達資料流程結尾之後完成。

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