TextReader.ReadToEnd メソッド

.NET Framework クラス ライブラリ リファレンス

TextReader.ReadToEnd メソッド

現在位置から TextReader の末尾まですべての文字を読み取り、1 つの文字列として返します。

名前空間: System.IO
アセンブリ: mscorlib (mscorlib.dll 内)
構文

Visual Basic (宣言)

Public Overridable Function
 ReadToEnd As String

Visual Basic (使用法)

Dim instance As TextReader
Dim returnValue As String

returnValue = instance.ReadToEnd

C#

public virtual string ReadToEnd ()

C++

public:
virtual String^ ReadToEnd ()

J#

public String ReadToEnd ()

JScript

public function ReadToEnd () : String

戻り値
現在位置から TextReader の末尾までのすべての文字を含む文字列。

例外

例外の種類	条件
IOException	I/O エラーが発生しました。
ObjectDisposedException	TextReader が閉じています。
OutOfMemoryException	返される文字列用のバッファを割り当てるためにはメモリが不足しています。
ArgumentOutOfRangeException	次の行の文字数が、MaxValue を超えています。

解説

現在のメソッドが OutOfMemoryException をスローした場合、基になる Stream 内のリーダーの位置は読み取ることができた文字数分だけ進みますが、既に内部 ReadToEnd バッファに読み取られた文字は破棄されます。ストリーム内のリーダーの位置は変更できないため、既に読み取られた文字は復元できません。もう一度アクセスするには、TextReader を再初期化する必要があります。ストリーム内の初期位置が不明であるか、ストリームがシークをサポートしない場合は、基になる Stream も再初期化する必要があります。

このような状況を回避し、信頼性の高いコードを作成するには、Read メソッドを使用して、割り当て済みのバッファに読み取った文字を格納する必要があります。

使用例

このコード例は、TextReader クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

Shared Sub ReadText(aTextReader As
 TextReader)
    Console.WriteLine("From {0} - {1}", _
        aTextReader.GetType().Name, aTextReader.ReadToEnd())
End Sub

C#

static void ReadText(TextReader textReader)
{
    Console.WriteLine("From {0} - {1}", 
        textReader.GetType().Name, textReader.ReadToEnd());
}

C++

void ReadText( TextReader^ textReader )
{
   Console::WriteLine( "From {0} - {1}", textReader->GetType()->Name,
 textReader->ReadToEnd() );
}

J#

static void ReadText(TextReader textReader)
 
{
    Console.WriteLine("From {0} - {1}", 
        textReader.GetType().get_Name(),textReader.ReadToEnd());
} //ReadText

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
TextReader クラス
TextReader メンバ
System.IO 名前空間
その他の技術情報
ファイルおよびストリーム入出力
方法 : ファイルからテキストを読み取る
方法 : ファイルにテキストを書き込む