StreamReader.ReadAsync メソッド

定義

名前空間:

System.IO

アセンブリ:

mscorlib.dll

オーバーロード

名前	説明
ReadAsync(Char[], Int32, Int32)	現在のストリームから指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。

ReadAsync(Char[], Int32, Int32)

現在のストリームから指定した最大文字数を非同期的に読み取り、指定したインデックスから始まるデータをバッファーに書き込みます。

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

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

[<System.Runtime.InteropServices.ComVisible(false)>]
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 (ゼロ) にすることができます。

属性

ComVisibleAttribute

例外

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)によってスローされる例外を参照してください。