StreamReader Classe

Definição

Implementa um TextReader que lê caracteres de um fluxo de bytes em uma codificação específica.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
Herança
Atributos

Exemplos

O exemplo a seguir usa uma instância de StreamReader para ler o texto de um arquivo.The following example uses an instance of StreamReader to read text from a file. O construtor usado neste exemplo não tem suporte para uso em aplicativos Windows StoreWindows Store.The constructor used in this example is not supported for use in Windows StoreWindows 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

O exemplo a seguir instancia um objeto StreamReader e chama seu método ReadAsync para ler um arquivo de forma assíncrona.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.

Comentários

StreamReader é projetada para entrada de caracteres em uma codificação específica, enquanto a classe Stream é projetada para entrada e saída de bytes.StreamReader is designed for character input in a particular encoding, whereas the Stream class is designed for byte input and output. Use StreamReader para ler linhas de informações de um arquivo de texto padrão.Use StreamReader for reading lines of information from a standard text file.

Importante

Esse tipo implementa a interface IDisposable.This type implements the IDisposable interface. Quando você terminar de usar o tipo, deverá descartá-lo direta ou indiretamente.When you have finished using the type, you should dispose of it either directly or indirectly. Para descartar o tipo diretamente, chame o método Dispose dele em um bloco try/catch.To dispose of the type directly, call its Dispose method in a try/catch block. Para descartá-lo indiretamente, use um constructo de linguagem como using ( em C#) ou Using (em Visual Basic).To dispose of it indirectly, use a language construct such as using (in C#) or Using (in Visual Basic). Saiba mais na seção "Como usar um objeto que implementa IDisposable" no tópico da interface IDisposable.For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.

StreamReader o padrão é a codificação UTF-8, a menos que especificado de outra forma, em vez de padronizar para a página de código ANSI para o sistema atual.StreamReader defaults to UTF-8 encoding unless specified otherwise, instead of defaulting to the ANSI code page for the current system. O UTF-8 manipula caracteres Unicode corretamente e fornece resultados consistentes em versões localizadas do sistema operacional.UTF-8 handles Unicode characters correctly and provides consistent results on localized versions of the operating system. Se você obtiver a codificação de caracteres atual usando a propriedade CurrentEncoding, o valor não será confiável até depois do primeiro método Read, pois a detecção automática de codificação não é feita até a primeira chamada para um método 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.

Por padrão, um StreamReader não é thread-safe.By default, a StreamReader is not thread safe. Consulte TextReader.Synchronized para um wrapper thread-safe.See TextReader.Synchronized for a thread-safe wrapper.

O método Read(Char[], Int32, Int32) e Write(Char[], Int32, Int32) sobrecarrega a leitura e gravação do número de caracteres especificado pelo parâmetro 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. Eles devem ser diferenciados de BufferedStream.Read e BufferedStream.Write, que lêem e gravam o número de bytes especificado pelo parâmetro 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. Use os métodos BufferedStream apenas para ler e gravar um número integral de elementos de matriz de bytes.Use the BufferedStream methods only for reading and writing an integral number of byte array elements.

Observação

Ao ler de um Stream, é mais eficiente usar um buffer que tenha o mesmo tamanho que o buffer interno do fluxo.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.

Para obter uma lista de tarefas comuns de e/s, consulte tarefas comuns de e/s.For a list of common I/O tasks, see Common I/O Tasks.

Construtores

StreamReader(Stream)

Inicializa uma nova instância da classe StreamReader para o fluxo especificado.Initializes a new instance of the StreamReader class for the specified stream.

StreamReader(Stream, Boolean)

Inicializa uma nova instância da classe StreamReader para o fluxo especificado, com a opção de detecção da marca da ordem de byte especificada.Initializes a new instance of the StreamReader class for the specified stream, with the specified byte order mark detection option.

StreamReader(Stream, Encoding)

Inicializa uma nova instância da classe StreamReader para o fluxo especificado, com a codificação de caractere especificada.Initializes a new instance of the StreamReader class for the specified stream, with the specified character encoding.

StreamReader(Stream, Encoding, Boolean)

Inicializa uma nova instância da classe StreamReader para o fluxo especificado, com a codificação de caracteres e a opção de detecção de marca de ordem de byte especificadas.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)

Inicializa uma nova instância da classe StreamReader para o fluxo especificado, com a codificação de caracteres, a opção de detecção de marca de ordem de byte e o tamanho do buffer especificados.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)

Inicializa uma nova instância da classe StreamReader para o fluxo especificado com base na codificação de caractere especificada, na opção de detecção de marca de ordem de byte, no tamanho do buffer e, opcionalmente, deixa o fluxo aberto.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)

Inicializa uma nova instância da classe StreamReader para o nome de arquivo especificado.Initializes a new instance of the StreamReader class for the specified file name.

StreamReader(String, Boolean)

Inicializa uma nova instância da classe StreamReader do nome do arquivo especificado, com a opção de detecção de marca de ordem de byte especificada.Initializes a new instance of the StreamReader class for the specified file name, with the specified byte order mark detection option.

StreamReader(String, Encoding)

Inicializa uma nova instância da classe StreamReader para o nome de arquivo especificado, com a codificação de caractere especificada.Initializes a new instance of the StreamReader class for the specified file name, with the specified character encoding.

StreamReader(String, Encoding, Boolean)

Inicializa uma nova instância da classe StreamReader para o nome de arquivo especificado, com a codificação de caractere e opção de detecção da marca da ordem de byte especificada.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)

Inicializa uma nova instância da classe StreamReader para o nome de arquivo especificado, com a codificação de caracteres, a opção de detecção de marca de ordem de byte e o tamanho do buffer especificados.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.

Campos

Null

Um objeto StreamReader em torno de um fluxo vazio.A StreamReader object around an empty stream.

Propriedades

BaseStream

Retorna o fluxo subjacente.Returns the underlying stream.

CurrentEncoding

Obtém a codificação de caracteres atual que está sendo usada pelo objeto StreamReader atual.Gets the current character encoding that the current StreamReader object is using.

EndOfStream

Obtém um valor que indica se a posição do fluxo atual está no final do fluxo.Gets a value that indicates whether the current stream position is at the end of the stream.

Métodos

Close()

Fecha o objeto StreamReader e o fluxo subjacente e libera os recursos do sistema associados ao leitor.Closes the StreamReader object and the underlying stream, and releases any system resources associated with the reader.

CreateObjRef(Type)

Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Herdado de MarshalByRefObject)
DiscardBufferedData()

Limpa o buffer interno.Clears the internal buffer.

Dispose()

Libera todos os recursos usados pelo objeto TextReader.Releases all resources used by the TextReader object.

(Herdado de TextReader)
Dispose(Boolean)

Fecha o fluxo subjacente, libera os recursos não gerenciados usados pelo StreamReader e, opcionalmente, libera os recursos gerenciados.Closes the underlying stream, releases the unmanaged resources used by the StreamReader, and optionally releases the managed resources.

Equals(Object)

Determina se o objeto especificado é igual ao objeto atual.Determines whether the specified object is equal to the current object.

(Herdado de Object)
GetHashCode()

Serve como a função de hash padrão.Serves as the default hash function.

(Herdado de Object)
GetLifetimeService()

Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Herdado de MarshalByRefObject)
GetType()

Obtém o Type da instância atual.Gets the Type of the current instance.

(Herdado de Object)
InitializeLifetimeService()

Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância.Obtains a lifetime service object to control the lifetime policy for this instance.

(Herdado de MarshalByRefObject)
MemberwiseClone()

Cria uma cópia superficial do Object atual.Creates a shallow copy of the current Object.

(Herdado de Object)
MemberwiseClone(Boolean)

Cria uma cópia superficial do objeto MarshalByRefObject atual.Creates a shallow copy of the current MarshalByRefObject object.

(Herdado de MarshalByRefObject)
Peek()

Retorna o próximo caractere disponível, mas não o consome.Returns the next available character but does not consume it.

Read()

Lê o próximo caractere do fluxo de entrada e avança a posição do caractere em um caractere.Reads the next character from the input stream and advances the character position by one character.

Read(Char[], Int32, Int32)

Lê um máximo especificado de caracteres do fluxo atual em um buffer, começando no índice especificado.Reads a specified maximum of characters from the current stream into a buffer, beginning at the specified index.

Read(Span<Char>)

Lê os caracteres do fluxo atual para um intervalo.Reads the characters from the current stream into a span.

ReadAsync(Char[], Int32, Int32)

Lê um máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado.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)

Lê de forma assíncrona os caracteres do fluxo atual para um bloco de memória.Asynchronously reads the characters from the current stream into a memory block.

ReadBlock(Char[], Int32, Int32)

Lê um máximo especificado de caracteres do fluxo atual e grava os dados em um buffer, começando no índice especificado.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>)

Lê os caracteres do fluxo atual e grava os dados em um buffer.Reads the characters from the current stream and writes the data to a buffer.

ReadBlockAsync(Char[], Int32, Int32)

Lê um máximo especificado de caracteres do fluxo atual de forma assíncrona e grava os dados em um buffer, começando no índice especificado.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)

Lê de forma assíncrona os caracteres do fluxo atual e grava os dados em um buffer.Asynchronously reads the characters from the current stream and writes the data to a buffer.

ReadLine()

Lê uma linha de caracteres do fluxo atual e retorna os dados como uma cadeia de caracteres.Reads a line of characters from the current stream and returns the data as a string.

ReadLineAsync()

Lê uma linha de caracteres assincronamente do fluxo atual e retorna os dados como uma cadeia de caracteres.Reads a line of characters asynchronously from the current stream and returns the data as a string.

ReadToEnd()

Lê todos os caracteres da posição atual até o final do fluxo.Reads all characters from the current position to the end of the stream.

ReadToEndAsync()

Lê todos os caracteres da posição atual até o final do fluxo de forma assíncrona e os retorna como uma cadeia de caracteres.Reads all characters from the current position to the end of the stream asynchronously and returns them as one string.

ToString()

Retorna uma cadeia de caracteres que representa o objeto atual.Returns a string that represents the current object.

(Herdado de Object)

Implantações explícitas de interface

IDisposable.Dispose()

Para obter uma descrição desse membro, consulte Dispose().For a description of this member, see Dispose().

(Herdado de TextReader)

Aplica-se a

Veja também