FileStream Classe

Définition

Espace de noms:

System.IO

Assembly:

System.Runtime.dll

Source:

FileStream.cs

Fournit un Stream pour un fichier, prenant en charge les opérations de lecture et d’écriture synchrones et asynchrones.

public ref class FileStream : System::IO::Stream

public class FileStream : System.IO.Stream

type FileStream = class
    inherit Stream

Public Class FileStream
Inherits Stream

Héritage

Object

MarshalByRefObject

Stream

FileStream

Dérivé

System.IO.IsolatedStorage.IsolatedStorageFileStream

Exemples

L’exemple suivant illustre certains constructeurs FileStream.

using namespace System;
using namespace System::IO;
using namespace System::Text;

void AddText( FileStream^ fs, String^ value )
{
   array<Byte>^info = (gcnew UTF8Encoding( true ))->GetBytes( value );
   fs->Write( info, 0, info->Length );
}

int main()
{
   String^ path = "c:\\temp\\MyTest.txt";
   
   // Delete the file if it exists.
   if ( File::Exists( path ) )
   {
      File::Delete( path );
   }

   //Create the file.
   {
      FileStream^ fs = File::Create( path );
      try
      {
         AddText( fs, "This is some text" );
         AddText( fs, "This is some more text," );
         AddText( fs, "\r\nand this is on a new line" );
         AddText( fs, "\r\n\r\nThe following is a subset of characters:\r\n" );
         for ( int i = 1; i < 120; i++ )
         {
            AddText( fs, Convert::ToChar( i ).ToString() );
            
            //Split the output at every 10th character.
            if ( Math::IEEERemainder( Convert::ToDouble( i ), 10 ) == 0 )
            {
               AddText( fs, "\r\n" );
            }
         }
      }
      finally
      {
         if ( fs )
            delete (IDisposable^)fs;
      }
   }
   
   //Open the stream and read it back.
   {
      FileStream^ fs = File::OpenRead( path );
      try
      {
         array<Byte>^b = gcnew array<Byte>(1024);
         UTF8Encoding^ temp = gcnew UTF8Encoding( true );
         while ( fs->Read( b, 0, b->Length ) > 0 )
         {
            Console::WriteLine( temp->GetString( b ) );
         }
      }
      finally
      {
         if ( fs )
            delete (IDisposable^)fs;
      }
   }
}

using System;
using System.IO;
using System.Text;

class Test
{

    public static void Main()
    {
        string path = @"c:\temp\MyTest.txt";

        // Delete the file if it exists.
        if (File.Exists(path))
        {
            File.Delete(path);
        }

        //Create the file.
        using (FileStream fs = File.Create(path))
        {
            AddText(fs, "This is some text");
            AddText(fs, "This is some more text,");
            AddText(fs, "\r\nand this is on a new line");
            AddText(fs, "\r\n\r\nThe following is a subset of characters:\r\n");

            for (int i=1;i < 120;i++)
            {
                AddText(fs, Convert.ToChar(i).ToString());
            }
        }

        //Open the stream and read it back.
        using (FileStream fs = File.OpenRead(path))
        {
            byte[] b = new byte[1024];
            UTF8Encoding temp = new UTF8Encoding(true);
            int readLen;
            while ((readLen = fs.Read(b,0,b.Length)) > 0)
            {
                Console.WriteLine(temp.GetString(b,0,readLen));
            }
        }
    }

    private static void AddText(FileStream fs, string value)
    {
        byte[] info = new UTF8Encoding(true).GetBytes(value);
        fs.Write(info, 0, info.Length);
    }
}

open System
open System.IO
open System.Text

let addText (fs:FileStream) (value: string) =
    let info = UTF8Encoding(true).GetBytes value
    fs.Write(info, 0, info.Length);

let path = @"c:\temp\MyTest.txt"

// Delete the file if it exists.
if File.Exists path then
    File.Delete path

//Create the file.
do
    use fs = File.Create path

    addText fs "This is some text"
    addText fs "This is some more text,"
    addText fs "\r\nand this is on a new line"
    addText fs "\r\n\r\nThe following is a subset of characters:\r\n"

    for i = 1 to 119 do
        Convert.ToChar i
        |> string
        |> addText fs
    
do
    //Open the stream and read it back.
    use fs = File.OpenRead path
    let b = Array.zeroCreate 1024
    let temp = UTF8Encoding true
    let mutable readLen = fs.Read(b,0,b.Length);
    while readLen> 0 do
        printfn $"{temp.GetString(b,0,readLen)}"
        readLen <- fs.Read(b,0,b.Length)

Imports System.IO
Imports System.Text

Public Class Test

    Public Shared Sub Main()
        Dim path As String = "c:\temp\MyTest.txt"

        ' Delete the file if it exists.
        If File.Exists(path) Then
            File.Delete(path)
        End If

        'Create the file.
        Dim fs As FileStream = File.Create(path)

        AddText(fs, "This is some text")
        AddText(fs, "This is some more text,")
        AddText(fs, Environment.NewLine & "and this is on a new line")
        AddText(fs, Environment.NewLine & Environment.NewLine)
        AddText(fs, "The following is a subset of characters:" & Environment.NewLine)

        Dim i As Integer

        For i = 1 To 120
            AddText(fs, Convert.ToChar(i).ToString())

        Next

        fs.Close()

        'Open the stream and read it back.
        fs = File.OpenRead(path)
        Dim b(1023) As Byte
        Dim temp As UTF8Encoding = New UTF8Encoding(True)

        Do While fs.Read(b, 0, b.Length) > 0
            Console.WriteLine(temp.GetString(b))
        Loop

        fs.Close()
    End Sub

    Private Shared Sub AddText(ByVal fs As FileStream, ByVal value As String)
        Dim info As Byte() = New UTF8Encoding(True).GetBytes(value)
        fs.Write(info, 0, info.Length)
    End Sub
End Class

L’exemple suivant montre comment écrire dans un fichier de manière asynchrone. Ce code s’exécute dans une application WPF qui a un TextBlock nommé UserInput et un bouton connecté à un gestionnaire d’événements Click nommé Button_Click. Le chemin d’accès au fichier doit être remplacé par un fichier qui existe sur l’ordinateur.

using System;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Controls;
using System.IO;

namespace WpfApplication1
{
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
        }

        private async void Button_Click(object sender, RoutedEventArgs e)
        {
            UnicodeEncoding uniencoding = new UnicodeEncoding();
            string filename = @"c:\Users\exampleuser\Documents\userinputlog.txt";

            byte[] result = uniencoding.GetBytes(UserInput.Text);

            using (FileStream SourceStream = File.Open(filename, FileMode.OpenOrCreate))
            {
                SourceStream.Seek(0, SeekOrigin.End);
                await SourceStream.WriteAsync(result, 0, result.Length);
            }
        }
    }
}

Imports System.IO
Imports System.Text

Class MainWindow
    Private Async Sub Button_Click(sender As Object, e As RoutedEventArgs)
        Dim uniencoding As UnicodeEncoding = New UnicodeEncoding()
        Dim filename As String = "c:\Users\exampleuser\Documents\userinputlog.txt"

        Dim result As Byte() = uniencoding.GetBytes(UserInput.Text)

        Using SourceStream As FileStream = File.Open(filename, FileMode.OpenOrCreate)
            SourceStream.Seek(0, SeekOrigin.End)
            Await SourceStream.WriteAsync(result, 0, result.Length)
        End Using
    End Sub
End Class

Remarques

Pour plus d’informations sur cette API, consultez remarques d’API supplémentaires pour FileStream.

Constructeurs

FileStream(IntPtr, FileAccess)	Obsolète. Initialise une nouvelle instance de la classe FileStream pour le handle de fichier spécifié, avec l’autorisation de lecture/écriture spécifiée.
FileStream(IntPtr, FileAccess, Boolean)	Obsolète. Initialise une nouvelle instance de la classe FileStream pour le handle de fichier spécifié, avec l’autorisation de lecture/écriture spécifiée et FileStream propriété de l’instance.
FileStream(IntPtr, FileAccess, Boolean, Int32)	Obsolète. Initialise une nouvelle instance de la classe FileStream pour le handle de fichier spécifié, avec l’autorisation de lecture/écriture spécifiée, FileStream propriété de l’instance et la taille de mémoire tampon spécifiées.
FileStream(IntPtr, FileAccess, Boolean, Int32, Boolean)	Obsolète. Initialise une nouvelle instance de la classe FileStream pour le handle de fichier spécifié, avec l’autorisation de lecture/écriture spécifiée, FileStream propriété de l’instance, la taille de la mémoire tampon et l’état synchrone ou asynchrone.
FileStream(SafeFileHandle, FileAccess)	Initialise une nouvelle instance de la classe FileStream pour le handle de fichier spécifié, avec l’autorisation de lecture/écriture spécifiée.
FileStream(SafeFileHandle, FileAccess, Int32)	Initialise une nouvelle instance de la classe FileStream pour le handle de fichier spécifié, avec l’autorisation de lecture/écriture spécifiée et la taille de mémoire tampon spécifiée.
FileStream(SafeFileHandle, FileAccess, Int32, Boolean)	Initialise une nouvelle instance de la classe FileStream pour le handle de fichier spécifié, avec l’autorisation de lecture/écriture spécifiée, la taille de la mémoire tampon et l’état synchrone ou asynchrone.
FileStream(String, FileMode)	Initialise une nouvelle instance de la classe FileStream avec le chemin d’accès et le mode de création spécifiés.
FileStream(String, FileMode, FileAccess)	Initialise une nouvelle instance de la classe FileStream avec le chemin d’accès, le mode de création et l’autorisation de lecture/écriture spécifiés.
FileStream(String, FileMode, FileAccess, FileShare)	Initialise une nouvelle instance de la classe FileStream avec le chemin d’accès, le mode de création, l’autorisation de lecture/écriture et l’autorisation de partage spécifiées.
FileStream(String, FileMode, FileAccess, FileShare, Int32)	Initialise une nouvelle instance de la classe FileStream avec le chemin d’accès, le mode de création, l’autorisation de lecture/écriture et de partage et la taille de mémoire tampon spécifiées.
FileStream(String, FileMode, FileAccess, FileShare, Int32, Boolean)	Initialise une nouvelle instance de la classe FileStream avec le chemin d’accès, le mode de création, l’autorisation de lecture/écriture et de partage, la taille de la mémoire tampon et l’état synchrone ou asynchrone spécifié.
FileStream(String, FileMode, FileAccess, FileShare, Int32, FileOptions)	Initialise une nouvelle instance de la classe FileStream avec le chemin d’accès, le mode de création, l’autorisation de lecture/écriture et de partage, l’accès à d’autres FileStreams peut avoir le même fichier, la taille de la mémoire tampon et d’autres options de fichier.
FileStream(String, FileStreamOptions)	Initialise une nouvelle instance de la classe FileStream avec le chemin d’accès, le mode de création, l’autorisation de lecture/écriture et de partage, la taille de mémoire tampon, les options de fichier supplémentaires, la taille de préallocation et l’accès aux autres FileStreams peut avoir le même fichier.

Propriétés

CanRead	Obtient une valeur qui indique si le flux actuel prend en charge la lecture.
CanSeek	Obtient une valeur qui indique si le flux actuel prend en charge la recherche.
CanTimeout	Obtient une valeur qui détermine si le flux actuel peut expirer. (Hérité de Stream)
CanWrite	Obtient une valeur qui indique si le flux actuel prend en charge l’écriture.
Handle	Obsolète. Obtient le handle de fichier du système d’exploitation pour le fichier encapsulé par l’objet FileStream actuel.
IsAsync	Obtient une valeur qui indique si la FileStream a été ouverte de manière asynchrone ou synchrone.
Length	Obtient la longueur en octets du flux.
Name	Obtient le chemin absolu du fichier ouvert dans le FileStream.
Position	Obtient ou définit la position actuelle de ce flux.
ReadTimeout	Obtient ou définit une valeur, en millisecondes, qui détermine la durée pendant laquelle le flux tente de lire avant l’expiration du délai d’attente. (Hérité de Stream)
SafeFileHandle	Obtient un objet SafeFileHandle qui représente le handle de fichier du système d’exploitation pour le fichier encapsulé par l’objet FileStream actuel.
WriteTimeout	Obtient ou définit une valeur, en millisecondes, qui détermine la durée pendant laquelle le flux tentera d’écrire avant l’expiration du délai d’attente. (Hérité de Stream)

Méthodes

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Commence une opération de lecture asynchrone. Envisagez d’utiliser ReadAsync(Byte[], Int32, Int32, CancellationToken) à la place.
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Commence une opération d’écriture asynchrone. Envisagez d’utiliser WriteAsync(Byte[], Int32, Int32, CancellationToken) à la place.
Close()	Ferme le flux actuel et libère toutes les ressources (telles que les sockets et les handles de fichiers) associées au flux actuel. Au lieu d’appeler cette méthode, vérifiez que le flux est correctement supprimé. (Hérité de Stream)
CopyTo(Stream)	Lit les octets du flux actuel et les écrit dans un autre flux. Les deux positions de flux sont avancées par le nombre d’octets copiés. (Hérité de Stream)
CopyTo(Stream, Int32)	Lit les octets du flux actuel et les écrit dans un autre flux à l’aide d’une taille de mémoire tampon spécifiée. Les deux positions de flux sont avancées par le nombre d’octets copiés. (Hérité de Stream)
CopyToAsync(Stream)	Lit de manière asynchrone les octets du flux actuel et les écrit dans un autre flux. Les deux positions de flux sont avancées par le nombre d’octets copiés. (Hérité de Stream)
CopyToAsync(Stream, CancellationToken)	Lit de manière asynchrone les octets du flux actuel et les écrit dans un autre flux à l’aide d’un jeton d’annulation spécifié. Les deux positions de flux sont avancées par le nombre d’octets copiés. (Hérité de Stream)
CopyToAsync(Stream, Int32)	Lit de façon asynchrone les octets du flux actuel et les écrit dans un autre flux à l’aide d’une taille de mémoire tampon spécifiée. Les deux positions de flux sont avancées par le nombre d’octets copiés. (Hérité de Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Lit de manière asynchrone les octets du flux de fichiers actuel et les écrit dans un autre flux à l’aide d’une taille de mémoire tampon et d’un jeton d’annulation spécifiés.
CreateObjRef(Type)	Crée un objet qui contient toutes les informations pertinentes requises pour générer un proxy utilisé pour communiquer avec un objet distant. (Hérité de MarshalByRefObject)
CreateWaitHandle()	Obsolète. Alloue un objet WaitHandle. (Hérité de Stream)
Dispose()	Libère toutes les ressources utilisées par le Stream. (Hérité de Stream)
Dispose(Boolean)	Libère les ressources non managées utilisées par le FileStream et libère éventuellement les ressources managées.
DisposeAsync()	Libère de façon asynchrone les ressources non managées utilisées par le FileStream.
EndRead(IAsyncResult)	Attend la fin de l’opération de lecture asynchrone en attente. (Envisagez d’utiliser ReadAsync(Byte[], Int32, Int32, CancellationToken) à la place.)
EndWrite(IAsyncResult)	Termine une opération d’écriture asynchrone et bloque jusqu’à ce que l’opération d’E/S soit terminée. (Envisagez d’utiliser WriteAsync(Byte[], Int32, Int32, CancellationToken) à la place.)
Equals(Object)	Détermine si l’objet spécifié est égal à l’objet actuel. (Hérité de Object)
Finalize()	Garantit que les ressources sont libérées et que d’autres opérations de nettoyage sont effectuées lorsque le garbage collector récupère le FileStream.
Flush()	Efface les mémoires tampons pour ce flux et provoque l’écriture de toutes les données mises en mémoire tampon dans le fichier.
Flush(Boolean)	Efface les mémoires tampons pour ce flux et entraîne l’écriture de toutes les données mises en mémoire tampon dans le fichier, et efface également toutes les mémoires tampons de fichier intermédiaires.
FlushAsync()	Efface de façon asynchrone toutes les mémoires tampons de ce flux et entraîne l’écriture de toutes les données mises en mémoire tampon sur l’appareil sous-jacent. (Hérité de Stream)
FlushAsync(CancellationToken)	Efface de façon asynchrone toutes les mémoires tampons de ce flux, entraîne l’écriture de toutes les données mises en mémoire tampon sur l’appareil sous-jacent et surveille les demandes d’annulation.
GetHashCode()	Sert 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 actuel qui contrôle la stratégie de durée de vie de cette instance. (Hérité de MarshalByRefObject)
GetType()	Obtient la 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)
Lock(Int64, Int64)	Empêche d’autres processus de lire ou d’écrire dans l'FileStream.
MemberwiseClone()	Crée une copie superficielle du Objectactuel. (Hérité de Object)
MemberwiseClone(Boolean)	Crée une copie superficielle de l’objet MarshalByRefObject actuel. (Hérité de MarshalByRefObject)
ObjectInvariant()	Obsolète. Fournit la prise en charge d’un Contract. (Hérité de Stream)
Read(Byte[], Int32, Int32)	Lit un bloc d’octets du flux et écrit les données dans une mémoire tampon donnée.
Read(Span<Byte>)	Lit une séquence d’octets à partir du flux de fichiers actuel et avance la position dans le flux de fichiers en fonction du nombre d’octets lus.
ReadAsync(Byte[], Int32, Int32)	Lit de façon asynchrone une séquence d’octets à partir du flux actuel et avance la position dans le flux en fonction du nombre d’octets lus. (Hérité de Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Lit de façon asynchrone une séquence d’octets du flux de fichiers actuel et les écrit dans un tableau d’octets commençant par un décalage spécifié, avance la position dans le flux de fichiers par le nombre d’octets lus et surveille les demandes d’annulation.
ReadAsync(Memory<Byte>, CancellationToken)	Lit de façon asynchrone une séquence d’octets à partir du flux de fichiers actuel et les écrit dans une région de mémoire, avance la position dans le flux de fichiers par le nombre d’octets lus et surveille les demandes d’annulation.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Lit au moins un nombre minimal d’octets du flux actuel et avance la position dans le flux par le nombre d’octets lus. (Hérité de Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Lit de façon asynchrone au moins un nombre minimal d’octets à partir du flux actuel, avance la position dans le flux par le nombre d’octets lus et surveille les demandes d’annulation. (Hérité de Stream)
ReadByte()	Lit un octet à partir du fichier et avance la position de lecture d’un octet.
ReadExactly(Byte[], Int32, Int32)	Lit count nombre d’octets du flux actuel et avance la position dans le flux. (Hérité de Stream)
ReadExactly(Span<Byte>)	Lit les octets du flux actuel et avance la position dans le flux jusqu’à ce que le buffer soit rempli. (Hérité de Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Lit de façon asynchrone count nombre d’octets du flux actuel, avance la position dans le flux et surveille les demandes d’annulation. (Hérité de Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Lit de manière asynchrone les octets du flux actuel, avance la position dans le flux jusqu’à ce que le buffer soit rempli et surveille les demandes d’annulation. (Hérité de Stream)
Seek(Int64, SeekOrigin)	Définit la position actuelle de ce flux sur la valeur donnée.
SetLength(Int64)	Définit la longueur de ce flux sur la valeur donnée.
ToString()	Retourne une chaîne qui représente l’objet actuel. (Hérité de Object)
Unlock(Int64, Int64)	Autorise l’accès par d’autres processus à tout ou partie d’un fichier précédemment verrouillé.
Write(Byte[], Int32, Int32)	Écrit un bloc d’octets dans le flux de fichiers.
Write(ReadOnlySpan<Byte>)	Écrit une séquence d’octets d’une étendue en lecture seule dans le flux de fichiers actuel et avance la position actuelle dans ce flux de fichiers par le nombre d’octets écrits.
WriteAsync(Byte[], Int32, Int32)	Écrit de façon asynchrone une séquence d’octets dans le flux actuel et avance la position actuelle dans ce flux par le nombre d’octets écrits. (Hérité de Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Écrit de façon asynchrone une séquence d’octets dans le flux actuel, avance la position actuelle dans ce flux par le nombre d’octets écrits et surveille les demandes d’annulation.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Écrit de façon asynchrone une séquence d’octets d’une région mémoire dans le flux de fichiers actuel, avance la position actuelle dans ce flux de fichiers par le nombre d’octets écrits et surveille les demandes d’annulation.
WriteByte(Byte)	Écrit un octet à la position actuelle dans le flux de fichiers.

Méthodes d’extension

GetAccessControl(FileStream)	Retourne les informations de sécurité d’un fichier.
SetAccessControl(FileStream, FileSecurity)	Modifie les attributs de sécurité d’un fichier existant.
CopyToAsync(Stream, PipeWriter, CancellationToken)	Lit de manière asynchrone les octets de l'Stream et les écrit dans le PipeWriterspécifié, à l’aide d’un jeton d’annulation.
ConfigureAwait(IAsyncDisposable, Boolean)	Configure la façon dont les attentes sur les tâches retournées à partir d’un jetable asynchrone sont effectuées.

Voir aussi

• File
• FileAccess
• FileMode
• FileShare
• fichier et flux d’E/S
• Guide pratique pour lire du texte à partir d’un fichier
• Comment : écrire du texte dans un fichier
• Comment : lire et écrire dans un fichier de données nouvellement créé