StreamReader.ReadToEnd メソッド

public:
 override System::String ^ ReadToEnd();

public override string ReadToEnd();

override this.ReadToEnd : unit -> string

Public Overrides Function ReadToEnd () As String

返品

ストリームの残りの部分を、現在の位置から末尾までの文字列として指定します。 現在の位置がストリームの末尾にある場合は、空の文字列 ("") を返します。

例外

例

次のコード例では、1 回の操作でファイルの末尾まで読み取ります。

using System;
using System.IO;

class Test
{
    
    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";

        try
        {
            if (File.Exists(path))
            {
                File.Delete(path);
            }

            using (StreamWriter sw = new StreamWriter(path))
            {
                sw.WriteLine("This");
                sw.WriteLine("is some text");
                sw.WriteLine("to test");
                sw.WriteLine("Reading");
            }

            using (StreamReader sr = new StreamReader(path))
            {
                //This allows you to do one Read operation.
                Console.WriteLine(sr.ReadToEnd());
            }
        }
        catch (Exception e)
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}

Imports System.IO
Imports System.Text

Public Class Test

    Public Shared Sub Main()
        Dim path As String = "c:\temp\MyTest.txt"

        Try
            If File.Exists(path) Then
                File.Delete(path)
            End If

            Dim sw As StreamWriter = New StreamWriter(path)
            sw.WriteLine("This")
            sw.WriteLine("is some text")
            sw.WriteLine("to test")
            sw.WriteLine("Reading")
            sw.Close()

            Dim sr As StreamReader = New StreamReader(path)

            'This allows you to do one Read operation.
            Console.WriteLine(sr.ReadToEnd())
            sr.Close()
        Catch e As Exception
            Console.WriteLine("The process failed: {0}", e.ToString())
        End Try
    End Sub
End Class

注釈

このメソッドは、TextReader.ReadToEnd をオーバーライドします。

ReadToEnd は、現在の位置からストリームの末尾までのすべての入力を読み取る必要がある場合に最適です。 ストリームから読み取る文字の数を制御する必要がある場合は、 Read(Char[], Int32, Int32) メソッドのオーバーロードを使用します。そのため、一般にパフォーマンスが向上します。

ReadToEnd は、ストリームがいつ終了したかを認識していることを前提としています。 サーバーが要求したときにのみデータを送信し、接続を閉じない対話型プロトコルの場合、 ReadToEnd はエンドに到達しないため無期限にブロックする可能性があるため、回避する必要があります。

Readメソッドを使用する場合は、ストリームの内部バッファーと同じサイズのバッファーを使用する方が効率的であることに注意してください。 ストリームの作成時にバッファーのサイズが指定されていない場合、既定のサイズは 4 KB (4096 バイト) です。

現在のメソッドが OutOfMemoryExceptionをスローした場合、基になる Stream オブジェクト内のリーダーの位置は、メソッドが読み取ることができた文字数だけ進みますが、内部 ReadLine バッファーに既に読み込まれている文字は破棄されます。 バッファーへのデータの読み取り後に基になるストリームの位置を操作すると、基になるストリームの位置が内部バッファーの位置と一致しない可能性があります。 内部バッファーをリセットするには、 DiscardBufferedData メソッドを呼び出します。ただし、このメソッドはパフォーマンスを低下させ、絶対に必要な場合にのみ呼び出す必要があります。

一般的な I/O タスクの一覧については、「 一般的な I/O タスク」を参照してください。

こちらもご覧ください

• ファイルおよびストリーム入出力
• 方法: ファイルからテキストを読み取る
• 方法: ファイルにテキストを書き込む