StreamReader Classe

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Source:

StreamReader.cs

Implémente TextReader qui lit les caractères à partir d'un flux d'octets dans un encodage particulier.

public ref class StreamReader : System::IO::TextReader

public class StreamReader : System.IO.TextReader

type StreamReader = class
    inherit TextReader

Public Class StreamReader
Inherits TextReader

Héritage

Object

MarshalByRefObject

TextReader

StreamReader

Exemples

L’exemple suivant utilise une instance de pour lire le StreamReader texte d’un fichier. Le constructeur utilisé dans cet exemple n’est pas pris en charge pour une utilisation dans les applications du Windows Store.

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

L’exemple suivant instancie un StreamReader objet et appelle sa ReadAsync méthode pour lire un fichier de manière asynchrone.

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.

Remarques

StreamReader est conçu pour l’entrée de caractères dans un encodage particulier, tandis que la classe est conçue pour l’entrée et la Stream sortie d’octets. Utilisez StreamReader pour lire des lignes d’informations à partir d’un fichier texte standard.

Important

Ce type implémente l'interface IDisposable. Une fois que vous avez fini d’utiliser le type, vous devez le supprimer directement ou indirectement. Pour supprimer directement le type Dispose, appelez sa méthode dans un bloc try/catch. Pour la supprimer indirectement, utilisez une construction de langage telle que using (dans C#) ou Using (dans Visual Basic). Pour plus d’informations, consultez la section « Utilisation d’un objet qui implémente IDisposable » dans la rubrique de l’interface IDisposable.

StreamReader utilise par défaut l’encodage UTF-8, sauf indication contraire, au lieu d’utiliser par défaut la page de codes ANSI pour le système actuel. UTF-8 gère correctement les caractères Unicode et fournit des résultats cohérents sur les versions localisées du système d’exploitation. Si vous obtenez l’encodage de caractères actuel à l’aide de la CurrentEncoding propriété , la valeur n’est fiable qu’après la première Read méthode, car la détection automatique de l’encodage n’est pas effectuée avant le premier appel à une Read méthode.

Par défaut, un StreamReader n’est pas thread-safe. Consultez TextReader.Synchronized pour obtenir un wrapper thread-safe.

Les Read(Char[], Int32, Int32) surcharges de la méthode et Write(Char[], Int32, Int32) lisent et écrivent le nombre de caractères spécifié par le count paramètre . Ceux-ci doivent être distingués de BufferedStream.Read et BufferedStream.Write, qui lisent et écrivent le nombre d’octets spécifié par le count paramètre . Utilisez les BufferedStream méthodes uniquement pour lire et écrire un nombre intégral d’éléments de tableau d’octets.

Notes

Lors de la lecture à partir d’un Stream, il est plus efficace d’utiliser une mémoire tampon de la même taille que la mémoire tampon interne du flux.

Pour obtenir la liste des tâches d’E/S courantes, consultez Tâches courantes d’E/S.

Constructeurs

StreamReader(Stream)	Initialise une nouvelle instance de la classe StreamReader pour le flux spécifié.
StreamReader(Stream, Boolean)	Initialise une nouvelle instance de la classe StreamReader pour le flux spécifié, avec l'option de détection de la marque d'ordre d'octet spécifiée.
StreamReader(Stream, Encoding)	Initialise une nouvelle instance de la classe StreamReader pour le flux spécifié, avec l'encodage de caractères spécifié.
StreamReader(Stream, Encoding, Boolean)	Initialise une nouvelle instance de la classe StreamReader pour le flux spécifié, avec l'encodage de caractères et l'option de détection de la marque d'ordre d'octet spécifiés.
StreamReader(Stream, Encoding, Boolean, Int32)	Initialise une nouvelle instance de la classe StreamReader pour le flux spécifié, avec l'encodage de caractères, l'option de détection de la marque d'ordre d'octet et la taille de mémoire tampon spécifiés.
StreamReader(Stream, Encoding, Boolean, Int32, Boolean)	Initialise une nouvelle instance de la classe StreamReader pour le flux spécifié en fonction de l'encodage de caractères, de l'option de détection de la marque d'ordre d'octet et de la taille de mémoire tampon spécifiés, et permet éventuellement de laisser le flux ouvert.
StreamReader(String)	Initialise une nouvelle instance de la classe StreamReader pour le nom de fichier spécifié.
StreamReader(String, Boolean)	Initialise une nouvelle instance de la classe StreamReader pour le nom de fichier spécifié, avec l'option de détection de la marque d'ordre d'octet spécifiée.
StreamReader(String, Encoding)	Initialise une nouvelle instance de la classe StreamReader pour le nom de fichier spécifié, avec l'encodage de caractères spécifié.
StreamReader(String, Encoding, Boolean)	Initialise une nouvelle instance de la classe StreamReader pour le nom de fichier spécifié, avec l'encodage de caractères et l'option de détection de la marque d'ordre d'octet spécifiés.
StreamReader(String, Encoding, Boolean, FileStreamOptions)	Initialise une nouvelle instance de la classe pour le StreamReader chemin d’accès de fichier spécifié, avec l’encodage de caractères spécifié, l’option de détection de marque d’ordre d’octet et configuré avec l’objet spécifiéFileStreamOptions.
StreamReader(String, Encoding, Boolean, Int32)	Initialise une nouvelle instance de la classe StreamReader pour le nom de fichier spécifié, avec l'encodage de caractères, l'option de détection de la marque d'ordre d'octet et la taille de mémoire tampon spécifiés.
StreamReader(String, FileStreamOptions)	Initialise une nouvelle instance de la classe pour le StreamReader chemin d’accès de fichier spécifié, en utilisant l’encodage par défaut, en activant la détection des marques d’ordre d’octet au début du fichier et configurées avec l’objet spécifiéFileStreamOptions.

Champs

Null	Objet StreamReader autour d'un flux vide.

Propriétés

BaseStream	Retourne le flux sous-jacent.
CurrentEncoding	Obtient l'encodage de caractères actuel utilisé par l'objet StreamReader actuel.
EndOfStream	Obtient une valeur qui indique si la position actuelle dans le flux est à la fin du flux.

Méthodes

Close()	Ferme l'objet StreamReader et le flux sous-jacent, et libère toutes les ressources système associées au lecteur.
CreateObjRef(Type)	Crée un objet contenant toutes les informations appropriées requises pour générer un proxy permettant de communiquer avec un objet distant. (Hérité de MarshalByRefObject)
DiscardBufferedData()	Efface la mémoire tampon interne.
Dispose()	Libère toutes les ressources utilisées par l'objet TextReader. (Hérité de TextReader)
Dispose(Boolean)	Ferme le flux sous-jacent, libère les ressources non managées utilisées par l'élément StreamReader et libère éventuellement les ressources managées.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetLifetimeService()	Obsolète. Récupère l'objet de service de durée de vie en cours qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
InitializeLifetimeService()	Obsolète. Obtient un objet de service de durée de vie pour contrôler la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
MemberwiseClone(Boolean)	Crée une copie superficielle de l'objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject)
Peek()	Retourne le caractère disponible suivant, mais ne le consomme pas.
Read()	Lit le caractère suivant dans le flux d'entrée et avance la position d'un caractère.
Read(Char[], Int32, Int32)	Lit un nombre maximal de caractères spécifié du flux actuel dans une mémoire tampon, en commençant à l'index spécifié.
Read(Span<Char>)	Lit les caractères du flux actuel dans une étendue.
ReadAsync(Char[], Int32, Int32)	Lit un nombre maximal spécifié de caractères dans le flux actuel de manière asynchrone, et écrit les données dans une mémoire tampon, en commençant à l'index spécifié.
ReadAsync(Memory<Char>, CancellationToken)	Lit de façon asynchrone les caractères du flux actuel dans un bloc de mémoire.
ReadBlock(Char[], Int32, Int32)	Lit un nombre maximal spécifié de caractères à partir du flux actuel et écrit les données dans une mémoire tampon, en commençant à l'index spécifié.
ReadBlock(Span<Char>)	Lit les caractères à partir du flux actuel et écrit les données dans une mémoire tampon.
ReadBlockAsync(Char[], Int32, Int32)	Lit un nombre maximal spécifié de caractères dans le flux actuel de manière asynchrone, et écrit les données dans une mémoire tampon, en commençant à l'index spécifié.
ReadBlockAsync(Memory<Char>, CancellationToken)	Lit de façon asynchrone les caractères à partir du flux actuel et écrit les données dans une mémoire tampon.
ReadLine()	Lit une ligne de caractères du flux actuel et retourne les données sous forme de chaîne.
ReadLineAsync()	Lit une ligne de caractères de manière asynchrone dans le flux actuel et retourne les données sous forme de chaîne.
ReadLineAsync(CancellationToken)	Lit une ligne de caractères de manière asynchrone dans le flux actuel et retourne les données sous forme de chaîne.
ReadToEnd()	Lit tous les caractères entre la position actuelle et la fin du flux.
ReadToEndAsync()	Lit tous les caractères entre la position actuelle et la fin du flux de manière asynchrone, puis les retourne sous la forme d'une chaîne.
ReadToEndAsync(CancellationToken)	Lit tous les caractères entre la position actuelle et la fin du flux de manière asynchrone, puis les retourne sous la forme d'une chaîne.
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Voir aussi

• Encoding
• Stream
• StreamWriter
• Fichier et flux de données E/S
• Procédure : lire le texte d’un fichier
• Procédure : écrire du texte dans un fichier
• Procédure : lire et écrire dans un fichier de données créé récemment