StreamReader.Read メソッド

リファレンス

定義

名前空間:: System.IO

アセンブリ:: System.IO.dll

アセンブリ:: System.Runtime.dll

アセンブリ:: System.Runtime.Extensions.dll

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

入力ストリームから次の文字または次の文字セットを読み込みます。

オーバーロード

Read()	入力ストリームから次の文字を読み込み、1 文字分だけ文字位置を進めます。
Read(Span<Char>)	現在のストリームからスパンに文字を読み込みます。
Read(Char[], Int32, Int32)	指定したインデックスを開始位置として、現在のストリームから、指定された最大文字数をバッファー内に読み取ります。

Read()

ソース:: StreamReader.cs

ソース:: StreamReader.cs

ソース:: StreamReader.cs

入力ストリームから次の文字を読み込み、1 文字分だけ文字位置を進めます。

public:
 override int Read();

public override int Read ();

override this.Read : unit -> int

Public Overrides Function Read () As Integer

戻り値

Int32

入力ストリームの次の文字を Int32 オブジェクトで表した値。使用できる文字がない場合は -1。

例外

IOException

I/O エラーが発生します。

例

次のコード例は、メソッドの簡単な使用方法を Read 示しています。

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::Write( (Char)sr->Read() );
         }
      }
      finally
      {
         delete sr;
      }
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The process failed: {0}", e );
   }
}

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.Write((char)sr.Read());
                }
            }
        }
        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)

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

次のコード例では、メソッドオーバーロードを使用して 1 文字を Read() 読み取り、ASCII 整数出力を 10 進数と 16 進数として書式設定する方法を示します。

using namespace System;
using namespace System::IO;
int main()
{
   
   //Create a FileInfo instance representing an existing text file.
   FileInfo^ MyFile = gcnew FileInfo( "c:\\csc.txt" );
   
   //Instantiate a StreamReader to read from the text file.
   StreamReader^ sr = MyFile->OpenText();
   
   //Read a single character.
   int FirstChar = sr->Read();
   
   //Display the ASCII number of the character read in both decimal and hexadecimal format.
   Console::WriteLine( "The ASCII number of the first character read is {0:D} in decimal and {1:X} in hexadecimal.", FirstChar, FirstChar );
   
   //
   sr->Close();
}

using System;
using System.IO;

class StrmRdrRead
{
public static void Main()
    {
    //Create a FileInfo instance representing an existing text file.
    FileInfo MyFile=new FileInfo(@"c:\csc.txt");
    //Instantiate a StreamReader to read from the text file.
    StreamReader sr=MyFile.OpenText();
    //Read a single character.
    int FirstChar=sr.Read();
    //Display the ASCII number of the character read in both decimal and hexadecimal format.
    Console.WriteLine("The ASCII number of the first character read is {0:D} in decimal and {1:X} in hexadecimal.",
        FirstChar, FirstChar);
    //
    sr.Close();
    }
}

Imports System.IO

Class StrmRdrRead
   
   Public Shared Sub Main()
      'Create a FileInfo instance representing an existing text file.
      Dim MyFile As New FileInfo("c:\csc.txt")
      'Instantiate a StreamReader to read from the text file.
      Dim sr As StreamReader = MyFile.OpenText()
      'Read a single character.
      Dim FirstChar As Integer = sr.Read()
      'Display the ASCII number of the character read in both decimal and hexadecimal format.
      Console.WriteLine("The ASCII number of the first character read is {0:D} in decimal and {1:X} in hexadecimal.", FirstChar, FirstChar)
      sr.Close()
   End Sub
End Class

注釈

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

ストリームの末尾に達した場合に -1 を返すことができるように、このメソッドは整数を返します。バッファーへのデータの読み取り後に基になるストリームの位置を操作すると、基になるストリームの位置が内部バッファーの位置と一致しない可能性があります。内部バッファーをリセットするには、メソッドを DiscardBufferedData 呼び出します。ただし、このメソッドはパフォーマンスを低下させ、絶対に必要な場合にのみ呼び出す必要があります。

共通 I/O タスクの一覧は、共通 I/O タスクを参照してください。

こちらもご覧ください

適用対象

Read(Span<Char>)

ソース:: StreamReader.cs

ソース:: StreamReader.cs

ソース:: StreamReader.cs

現在のストリームからスパンに文字を読み込みます。

public:
 override int Read(Span<char> buffer);

public override int Read (Span<char> buffer);

override this.Read : Span<char> -> int

Public Overrides Function Read (buffer As Span(Of Char)) As Integer

パラメーター

buffer: Span<Char>

このメソッドから制御が戻るときに、指定した文字のスパンが現在のソースから読み取られた文字に置き換えられます。

戻り値

Int32

読み込まれた文字数。ストリームの末尾でデータが読み込まれなかった場合は 0。この数値は、ストリーム内に使用できるデータがあるかどうかによって異なりますが、buffer の長さ以下の数値になります。

例外

IOException

ストリームから読み取った文字数が、buffer の長さを超えています。

ArgumentNullException

buffer が nullです。

適用対象

Read(Char[], Int32, Int32)

ソース:: StreamReader.cs

ソース:: StreamReader.cs

ソース:: StreamReader.cs

指定したインデックスを開始位置として、現在のストリームから、指定された最大文字数をバッファー内に読み取ります。

public:
 override int Read(cli::array <char> ^ buffer, int index, int count);

public override int Read (char[] buffer, int index, int count);

override this.Read : char[] * int * int -> int

Public Overrides Function Read (buffer As Char(), index As Integer, count As Integer) As Integer

パラメーター

buffer: Char[]

このメソッドが戻る時点で、指定した文字配列が入れられます。そのうち index から (index + count - 1) までの値が、現在のソースから読み取られた文字に置き換えられています。

index: Int32

書き込みの開始位置を示す buffer のインデックス。

count: Int32

読み取り対象の最大文字数。

戻り値

Int32

読み込まれた文字数。ストリームの末尾でデータが読み込まれなかった場合は 0。この数値は、ストリーム内に使用できるデータがあるかどうかによって異なりますが、count パラメーター以下の数値になります。

例外

ArgumentException

バッファーの長さから index を引いた値が count 未満です。

ArgumentNullException

buffer が nullです。

ArgumentOutOfRangeException

index または count が負の値です。

IOException

ストリームが閉じているなど、I/O エラーが発生します。

例

次のコード例では、ファイルの末尾に達するまで一度に 5 文字を読み取ります。

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
      {
         //This is an arbitrary size for this example.
         array<Char>^c = nullptr;
         while ( sr->Peek() >= 0 )
         {
            c = gcnew array<Char>(5);
            sr->Read( c, 0, c->Length );
            
            //The output will look odd, because
            //only five characters are read at a time.
            Console::WriteLine( c );
         }
      }
      finally
      {
         delete sr;
      }
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "The process failed: {0}", e );
   }
}

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 is an arbitrary size for this example.
                char[] c = null;

                while (sr.Peek() >= 0)
                {
                    c = new char[5];
                    sr.Read(c, 0, c.Length);
                    //The output will look odd, because
                    //only five characters are read at a time.
                    Console.WriteLine(c);
                }
            }
        }
        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)

            Do While sr.Peek() >= 0
                'This is an arbitrary size for this example.
                Dim c(5) As Char
                sr.Read(c, 0, c.Length)
                'The output will look odd, because
                'only five characters are read at a time.
                Console.WriteLine(c)
            Loop
            sr.Close()
        Catch e As Exception
            Console.WriteLine("The process failed: {0}", e.ToString())
        End Try
    End Sub
End Class

注釈

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

ストリームの末尾に達した場合に 0 を返すことができるように、このメソッドは整数を返します。

メソッドを使用する場合は、ストリームの Read 内部バッファーと同じサイズのバッファーを使用する方が効率的です。内部バッファーは目的のブロックサイズに設定され、常にブロックサイズよりも小さい値を読み取ります。ストリームの構築時に内部バッファーのサイズが指定されていない場合、既定のサイズは 4 KB (4096 バイト) です。バッファーへのデータの読み取り後に基になるストリームの位置を操作すると、基になるストリームの位置が内部バッファーの位置と一致しない可能性があります。内部バッファーをリセットするには、メソッドを DiscardBufferedData 呼び出します。ただし、このメソッドはパフォーマンスを低下させ、絶対に必要な場合にのみ呼び出す必要があります。

このメソッドは、パラメーターで count 指定された文字数が読み取られた後、またはファイルの末尾に達した後にを返します。 ReadBlock はのブロッキングバージョン Readです。

共通 I/O タスクの一覧は、共通 I/O タスクを参照してください。

こちらもご覧ください

適用対象

次の方法で共有

StreamReader.Read メソッド

定義

オーバーロード

Read()

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

Read(Span<Char>)

パラメーター

戻り値

例外

適用対象

Read(Char[], Int32, Int32)

パラメーター

戻り値

例外

例

注釈

こちらもご覧ください

適用対象

その他のリソース