StreamReader.Peek メソッドとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

StreamReader.Peek メソッド

読み取り可能な次の文字を返しますが、その文字は使用されません。

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

Visual Basic (宣言)

Public Overrides Function
 Peek As Integer

Visual Basic (使用法)

Dim instance As StreamReader
Dim returnValue As Integer

returnValue = instance.Peek

public override int Peek ()

C++

public:
virtual int Peek () override

public int Peek ()

JScript

public override function Peek () : int

戻り値
読み取り対象の次の文字を表す整数。使用できる文字がないか、ストリームがシークをサポートしていない場合は -1。

例外

例外の種類	条件
IOException	I/O エラーが発生しました。

解説

Peek メソッドは、ファイルの末尾に達したのか、または別のエラーが発生したのかを判断するために、整数値を返します。これにより、ユーザーは戻り値が -1 かどうかをチェックしてから Char 型にキャストできます。

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

Peek では StreamReader オブジェクトの現在位置は変わりません。それ以上読み取り可能な文字がない場合、戻り値は -1 です。

このメソッドの使用例については、「使用例」を参照してください。その他の一般的な I/O タスクまたは関連する I/O タスクの例を次の表に示します。

実行するタスク	参考例があるトピック
テキストファイルを作成する。	方法 : ファイルにテキストを書き込む
テキストファイルに書き込む。	方法 : ファイルにテキストを書き込む
テキストファイルから読み取る。	方法 : ファイルからテキストを読み取る
テキストをファイルに追加する。	方法 : ログファイルを開いて情報を追加する File.AppendText FileInfo.AppendText
ファイルのサイズを取得する。	FileInfo.Length
ファイルの属性を取得する。	File.GetAttributes
ファイルの属性を設定する。	File.SetAttributes
ファイルが存在するかどうかを判別する。	File.Exists
バイナリファイルから読み取る。	方法 : 新しく作成されたデータファイルに対して読み書きする
バイナリファイルに書き込む。	方法 : 新しく作成されたデータファイルに対して読み書きする

使用例

ファイルの末尾に到達するまでファイルから行を読み取るコード例を次に示します。

Visual Basic

Imports System
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)

            Do While sr.Peek() >= 0
                Console.WriteLine(sr.ReadLine())
            Loop
            sr.Close()
        Catch e As Exception
            Console.WriteLine("The process failed: {0}",
 e.ToString())
        End Try
    End Sub
End Class

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))
 
            {

                while (sr.Peek() >= 0) 
                {
                    Console.WriteLine(sr.ReadLine());
                }
            }
        } 
        catch (Exception e) 
        {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    }
}

C++

using namespace System;
using namespace System::IO;

int main()
{
   String^ path = "c:\\temp\\MyTest.txt";
   try
   {
      if ( File::Exists( path ) )
      {
         File::Delete( path );
      }
      StreamWriter^ sw = gcnew StreamWriter( path );
      try
      {
         sw->WriteLine( "This" );
         sw->WriteLine( "is some text" );
         sw->WriteLine( "to test" );
         sw->WriteLine( "Reading" );
      }
      finally
      {
         delete sw;
      }

      StreamReader^ sr = gcnew StreamReader( path );
      try
      {
         while ( sr->Peek() >= 0 )
         {
            Console::WriteLine( sr->ReadLine() );
         }
      }
      finally
      {
         delete sr;
      }
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The process failed: {0}", e );
   }
}

import System.*;
import System.IO.*;

class Test
{
    public static void main(String[]
 args)
    {
        String path = "c:\\temp\\MyTest.txt";

        try {
            if (File.Exists(path)) {
                File.Delete(path);
            }
            StreamWriter sw = new StreamWriter(path);
            try {
                sw.WriteLine("This");
                sw.WriteLine("is some text");
                sw.WriteLine("to test");
                sw.WriteLine("Reading");
            }
            finally {
                sw.Dispose();
            }
            StreamReader sr = new StreamReader(path);
            try {
                while (sr.Peek() >= 0) {
                    Console.WriteLine(sr.ReadLine());
                }
            }
            finally {
                sr.Dispose();
            }
        }
        catch (System.Exception e) {
            Console.WriteLine("The process failed: {0}", e.ToString());
        }
    } //main
} //Test