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>

非同期の読み取り操作を表す値タスク。 値タスクの type パラメーターの値には、読み取られた文字数が格納されます。ストリームの末尾でデータが読み取られなかった場合は 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)スローされる例外に関するページを参照してください。