StreamReader Класс

Определение

Реализует объект TextReader, который считывает символы из потока байтов в определенной кодировке.Implements a TextReader that reads characters from a byte stream in a particular encoding.

public ref class StreamReader : System::IO::TextReader
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class StreamReader : System.IO.TextReader
type StreamReader = class
    inherit TextReader
Public Class StreamReader
Inherits TextReader
Наследование
Атрибуты

Примеры

В следующем примере экземпляр StreamReader используется для чтения текста из файла.The following example uses an instance of StreamReader to read text from a file. Конструктор, используемый в этом примере, не поддерживается для использования в Магазин WindowsWindows Store приложениях.The constructor used in this example is not supported for use in Магазин WindowsWindows Store Apps.

using namespace System;
using namespace System::IO;
int main()
{
   try
   {
      // Create an instance of StreamReader to read from a file.
      StreamReader^ sr = gcnew StreamReader( "TestFile.txt" );
      try
      {
         String^ line;
         
         // Read and display lines from the file until the end of 
         // the file is reached.
         while ( line = sr->ReadLine() )
         {
            Console::WriteLine( line );
         }
      }
      finally
      {
         if ( sr )
            delete (IDisposable^)sr;
      }
   }
   catch ( Exception^ e ) 
   {
      // Let the user know what went wrong.
      Console::WriteLine( "The file could not be read:" );
      Console::WriteLine( e->Message );
   }
}
using System;
using System.IO;

class Test 
{
    public static void Main() 
    {
        try 
        {
            // Create an instance of StreamReader to read from a file.
            // The using statement also closes the StreamReader.
            using (StreamReader sr = new StreamReader("TestFile.txt")) 
            {
                string line;
                // Read and display lines from the file until the end of 
                // the file is reached.
                while ((line = sr.ReadLine()) != null) 
                {
                    Console.WriteLine(line);
                }
            }
        }
        catch (Exception e) 
        {
            // Let the user know what went wrong.
            Console.WriteLine("The file could not be read:");
            Console.WriteLine(e.Message);
        }
    }
}
Imports System.IO

Class Test
    Public Shared Sub Main()
        Try
            ' Create an instance of StreamReader to read from a file.
            Dim sr As StreamReader = New StreamReader("TestFile.txt")
            Dim line As String
            ' Read and display the lines from the file until the end 
            ' of the file is reached.
            Do
                line = sr.ReadLine()
                Console.WriteLine(Line)
            Loop Until line Is Nothing
            sr.Close()
        Catch E As Exception
            ' Let the user know what went wrong.
            Console.WriteLine("The file could not be read:")
            Console.WriteLine(E.Message)
        End Try
    End Sub
End Class

В следующем примере создается экземпляр объекта StreamReader и вызывается его метод ReadAsync для асинхронного чтения файла.The following example instantiates a StreamReader object and calls its ReadAsync method to read a file asynchronously.

using System;
using System.IO;
using System.Threading.Tasks;

class Example
{
    static async Task Main()
    {
        await ReadAndDisplayFilesAsync();
    }

    static async Task ReadAndDisplayFilesAsync()
    {
        String filename = "TestFile1.txt";
        Char[] buffer;
        
        using (var sr = new StreamReader(filename)) {
            buffer = new Char[(int)sr.BaseStream.Length];
            await sr.ReadAsync(buffer, 0, (int)sr.BaseStream.Length);
        }

        Console.WriteLine(new String(buffer));
    }
}
// The example displays the following output:
//       This is the first line of text in a relatively short file.
//       This is the second line.
//       This is the third line.
//       This is the fourth and final line.
Imports System.IO
Imports System.Threading.Tasks

Module Example
    Public Sub Main()
        ReadAndDisplayFilesAsync()
    End Sub

    Private Async Sub ReadAndDisplayFilesAsync()
        Dim filename As String = "TestFile1.txt"
        Dim buffer() As Char
        
        Using sr As New StreamReader(filename)
            ReDim buffer(CInt(sr.BaseStream.Length))
            Await sr.ReadAsync(buffer, 0, CInt(sr.BaseStream.Length))
        End Using

        Console.WriteLine(New String(buffer))
    End Sub
End Module
' The example displays the following output:
'       This is the first line of text in a relatively short file.
'       This is the second line.
'       This is the third line.
'       This is the fourth and final line.

Комментарии

StreamReader предназначен для ввода символов в определенной кодировке, тогда как класс Stream предназначен для ввода и вывода байтов.StreamReader is designed for character input in a particular encoding, whereas the Stream class is designed for byte input and output. Используйте StreamReader для чтения строк данных из стандартного текстового файла.Use StreamReader for reading lines of information from a standard text file.

Важно!

Этот тип реализует интерфейс IDisposable.This type implements the IDisposable interface. По окончании использования выдаленную ему память следует прямо или косвенно освободить.When you have finished using the type, you should dispose of it either directly or indirectly. Чтобы сделать это прямо, вызовите его метод Dispose в блоке try/catch.To dispose of the type directly, call its Dispose method in a try/catch block. Чтобы сделать это косвенно, используйте языковые конструкции, такие как using (в C#) или Using (в Visual Basic).To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). Дополнительные сведения см. в разделе "Использование объекта, реализующего IDisposable" в статье об интерфейсе IDisposable.For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

StreamReader по умолчанию имеет кодировку UTF-8, если не указано иное, вместо использования по умолчанию кодовой страницы ANSI для текущей системы.StreamReader defaults to UTF-8 encoding unless specified otherwise, instead of defaulting to the ANSI code page for the current system. UTF-8 обрабатывает символы Юникода правильно и обеспечивает единообразные результаты в локализованных версиях операционной системы.UTF-8 handles Unicode characters correctly and provides consistent results on localized versions of the operating system. Если вы получаете текущую кодировку символов с помощью свойства CurrentEncoding, это значение не является надежным до первого метода Read, так как автоматическое обнаружение кодировки не выполняется до первого вызова метода Read.If you get the current character encoding using the CurrentEncoding property, the value is not reliable until after the first Read method, since encoding auto detection is not done until the first call to a Read method.

По умолчанию StreamReader не является потокобезопасным.By default, a StreamReader is not thread safe. См. TextReader.Synchronized для потокобезопасной оболочки.See TextReader.Synchronized for a thread-safe wrapper.

Перегрузки методов Read(Char[], Int32, Int32) и Write(Char[], Int32, Int32) считывают и записывают количество символов, указанное параметром count.The Read(Char[], Int32, Int32) and Write(Char[], Int32, Int32) method overloads read and write the number of characters specified by the count parameter. Они должны отличаться от BufferedStream.Read и BufferedStream.Write, которые считывают и записывают число байтов, заданных параметром count.These are to be distinguished from BufferedStream.Read and BufferedStream.Write, which read and write the number of bytes specified by the count parameter. Используйте BufferedStream методы только для чтения и записи целого числа элементов массива байтов.Use the BufferedStream methods only for reading and writing an integral number of byte array elements.

Примечание

При чтении из Streamболее эффективно использовать буфер, размер которого совпадает с размером внутреннего буфера потока.When reading from a Stream, it is more efficient to use a buffer that is the same size as the internal buffer of the stream.

Список общих задач ввода-вывода см. в разделе Общие задачи ввода-вывода.For a list of common I/O tasks, see Common I/O Tasks.

Конструкторы

StreamReader(Stream)

Инициализирует новый экземпляр класса StreamReader для заданного потока.Initializes a new instance of the StreamReader class for the specified stream.

StreamReader(Stream, Boolean)

Инициализирует новый экземпляр класса StreamReader для указанного потока, используя заданный параметр обнаружения метки порядка следования байтов.Initializes a new instance of the StreamReader class for the specified stream, with the specified byte order mark detection option.

StreamReader(Stream, Encoding)

Инициализирует новый экземпляр класса StreamReader для заданного потока, используя указанную кодировку символов.Initializes a new instance of the StreamReader class for the specified stream, with the specified character encoding.

StreamReader(Stream, Encoding, Boolean)

Инициализирует новый экземпляр класса StreamReader для заданного потока, используя указанную кодировку символов и параметр обнаружения метки порядка байтов.Initializes a new instance of the StreamReader class for the specified stream, with the specified character encoding and byte order mark detection option.

StreamReader(Stream, Encoding, Boolean, Int32)

Инициализирует новый экземпляр класса StreamReader для заданного потока, используя указанную кодировку символов, параметр обнаружения метки порядка байтов и размер буфера.Initializes a new instance of the StreamReader class for the specified stream, with the specified character encoding, byte order mark detection option, and buffer size.

StreamReader(Stream, Encoding, Boolean, Int32, Boolean)

Инициализирует новый экземпляр класса StreamReader для заданного потока на основании заданной кодировки символов, параметра обнаружения метки порядка следования байтов и размера буфера, а также при необходимости оставляет поток открытым.Initializes a new instance of the StreamReader class for the specified stream based on the specified character encoding, byte order mark detection option, and buffer size, and optionally leaves the stream open.

StreamReader(String)

Инициализирует новый экземпляр класса StreamReader для указанного имени файла.Initializes a new instance of the StreamReader class for the specified file name.

StreamReader(String, Boolean)

Инициализирует новый экземпляр класса StreamReader для заданного имени файла, используя указанный параметр обнаружения меток порядка байтов.Initializes a new instance of the StreamReader class for the specified file name, with the specified byte order mark detection option.

StreamReader(String, Encoding)

Инициализирует новый экземпляр класса StreamReader для заданного имени файла, используя указанную кодировку символов.Initializes a new instance of the StreamReader class for the specified file name, with the specified character encoding.

StreamReader(String, Encoding, Boolean)

Инициализирует новый экземпляр класса StreamReader для заданного имени файла, используя указанную кодировку символов и параметр обнаружения меток порядка байтов.Initializes a new instance of the StreamReader class for the specified file name, with the specified character encoding and byte order mark detection option.

StreamReader(String, Encoding, Boolean, Int32)

Инициализирует новый экземпляр класса StreamReader для заданного имени файла, используя указанную кодировку символов, параметр обнаружения меток порядка байтов и размер буфера.Initializes a new instance of the StreamReader class for the specified file name, with the specified character encoding, byte order mark detection option, and buffer size.

Поля

Null

Объект StreamReader для пустого потока.A StreamReader object around an empty stream.

Свойства

BaseStream

Возвращает основной поток.Returns the underlying stream.

CurrentEncoding

Получает текущую кодировку символов, используемую текущим объектом StreamReader.Gets the current character encoding that the current StreamReader object is using.

EndOfStream

Получает значение, определяющее, находится ли позиция текущего потока в конце потока.Gets a value that indicates whether the current stream position is at the end of the stream.

Методы

Close()

Закрывает объект StreamReader и основной поток и освобождает все системные ресурсы, связанные с устройством чтения.Closes the StreamReader object and the underlying stream, and releases any system resources associated with the reader.

CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
DiscardBufferedData()

Очищает внутренний буфер.Clears the internal buffer.

Dispose()

Освобождает все ресурсы, используемые объектом TextReader.Releases all resources used by the TextReader object.

(Унаследовано от TextReader)
Dispose(Boolean)

Закрывает основной поток, освобождает неуправляемые ресурсы, используемые StreamReader, и при необходимости освобождает управляемые ресурсы.Closes the underlying stream, releases the unmanaged resources used by the StreamReader, and optionally releases the managed resources.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
Peek()

Возвращает следующий доступный символ, но не использует его.Returns the next available character but does not consume it.

Read()

Выполняет чтение следующего символа из входного потока и перемещает положение символа на одну позицию вперед.Reads the next character from the input stream and advances the character position by one character.

Read(Char[], Int32, Int32)

Считывает заданное максимальное количество символов из текущего потока в буфер начиная с заданного индекса.Reads a specified maximum of characters from the current stream into a buffer, beginning at the specified index.

Read(Span<Char>)

Считывает символы из текущего потока в диапазон.Reads the characters from the current stream into a span.

ReadAsync(Char[], Int32, Int32)

Асинхронно считывает указанное максимальное количество символов из текущего потока и записывает данные в буфер, начиная с заданного индекса.Reads a specified maximum number of characters from the current stream asynchronously and writes the data to a buffer, beginning at the specified index.

ReadAsync(Memory<Char>, CancellationToken)

Считывает символы из текущего потока в блок памяти в асинхронном режиме.Asynchronously reads the characters from the current stream into a memory block.

ReadBlock(Char[], Int32, Int32)

Считывает указанное максимальное количество символов из текущего потока и записывает данные в буфер, начиная с заданного индекса.Reads a specified maximum number of characters from the current stream and writes the data to a buffer, beginning at the specified index.

ReadBlock(Span<Char>)

Считывает символы из текущего потока и записывает данные в буфер.Reads the characters from the current stream and writes the data to a buffer.

ReadBlockAsync(Char[], Int32, Int32)

Асинхронно считывает указанное максимальное количество символов из текущего потока и записывает данные в буфер, начиная с заданного индекса.Reads a specified maximum number of characters from the current stream asynchronously and writes the data to a buffer, beginning at the specified index.

ReadBlockAsync(Memory<Char>, CancellationToken)

Считывает символы из текущего потока и записывает данные в буфер в асинхронном режиме.Asynchronously reads the characters from the current stream and writes the data to a buffer.

ReadLine()

Выполняет чтение строки символов из текущего потока и возвращает данные в виде строки.Reads a line of characters from the current stream and returns the data as a string.

ReadLineAsync()

Асинхронно выполняет чтение строки символов из текущего потока и возвращает данные в виде строки.Reads a line of characters asynchronously from the current stream and returns the data as a string.

ReadToEnd()

Считывает все символы, начиная с текущей позиции до конца потока.Reads all characters from the current position to the end of the stream.

ReadToEndAsync()

Асинхронно считывает все символы, начиная с текущей позиции до конца потока, и возвращает их в виде одной строки.Reads all characters from the current position to the end of the stream asynchronously and returns them as one string.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

IDisposable.Dispose()

Описание этого члена см. в разделе Dispose().For a description of this member, see Dispose().

(Унаследовано от TextReader)

Применяется к

Дополнительно