FileStream Klasse

Definition

Namespace:

System.IO

Assembly:

System.Runtime.dll

Quelle:

FileStream.cs

Stellt eine Stream für eine Datei bereit, die synchrone und asynchrone Lese- und Schreibvorgänge unterstützt.

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

public class FileStream : System.IO.Stream

type FileStream = class
    inherit Stream

Public Class FileStream
Inherits Stream

Vererbung

Object

MarshalByRefObject

Stream

FileStream

Abgeleitet

System.IO.IsolatedStorage.IsolatedStorageFileStream

Beispiele

Im folgenden Beispiel werden einige der FileStream-Konstruktoren veranschaulicht.

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

Das folgende Beispiel zeigt, wie Sie asynchron in eine Datei schreiben. Dieser Code wird in einer WPF-App mit dem Namen "UserInput" und einer Schaltfläche ausgeführt, die mit einem Click-Ereignishandler eingebunden ist, der Button_Click genannt wird. Der Dateipfad muss in eine Datei geändert werden, die auf dem Computer vorhanden ist.

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

Hinweise

Weitere Informationen zu dieser API finden Sie in Ergänzende API-Hinweise für FileStream-.

Konstruktoren

FileStream(IntPtr, FileAccess)	Veraltet. Initialisiert eine neue Instanz der FileStream Klasse für das angegebene Dateihandle mit der angegebenen Lese-/Schreibberechtigung.
FileStream(IntPtr, FileAccess, Boolean)	Veraltet. Initialisiert eine neue Instanz der FileStream-Klasse für das angegebene Dateihandle mit der angegebenen Lese-/Schreibberechtigung und FileStream Instanzbesitz.
FileStream(IntPtr, FileAccess, Boolean, Int32)	Veraltet. Initialisiert eine neue Instanz der FileStream Klasse für das angegebene Dateihandle mit der angegebenen Lese-/Schreibberechtigung, FileStream Instanzbesitz und Puffergröße.
FileStream(IntPtr, FileAccess, Boolean, Int32, Boolean)	Veraltet. Initialisiert eine neue Instanz der FileStream Klasse für das angegebene Dateihandle mit der angegebenen Lese-/Schreibberechtigung, FileStream Instanzbesitz, Puffergröße und synchronem oder asynchronem Zustand.
FileStream(SafeFileHandle, FileAccess)	Initialisiert eine neue Instanz der FileStream Klasse für das angegebene Dateihandle mit der angegebenen Lese-/Schreibberechtigung.
FileStream(SafeFileHandle, FileAccess, Int32)	Initialisiert eine neue Instanz der FileStream-Klasse für das angegebene Dateihandle mit der angegebenen Lese-/Schreibberechtigung und puffergröße.
FileStream(SafeFileHandle, FileAccess, Int32, Boolean)	Initialisiert eine neue Instanz der FileStream Klasse für das angegebene Dateihandle mit der angegebenen Lese-/Schreibberechtigung, Puffergröße und synchronem oder asynchronem Zustand.
FileStream(String, FileMode)	Initialisiert eine neue Instanz der FileStream Klasse mit dem angegebenen Pfad- und Erstellungsmodus.
FileStream(String, FileMode, FileAccess)	Initialisiert eine neue Instanz der FileStream Klasse mit dem angegebenen Pfad, Erstellungsmodus und Lese-/Schreibzugriff.
FileStream(String, FileMode, FileAccess, FileShare)	Initialisiert eine neue Instanz der FileStream Klasse mit dem angegebenen Pfad, erstellungsmodus, Lese-/Schreibberechtigung und Freigabeberechtigung.
FileStream(String, FileMode, FileAccess, FileShare, Int32)	Initialisiert eine neue Instanz der FileStream Klasse mit dem angegebenen Pfad, erstellungsmodus, Lese-/Schreibzugriff und Freigabeberechtigung und Puffergröße.
FileStream(String, FileMode, FileAccess, FileShare, Int32, Boolean)	Initialisiert eine neue Instanz der FileStream Klasse mit dem angegebenen Pfad, Erstellungsmodus, Lese-/Schreibzugriff und Freigabeberechtigung, Puffergröße und synchronem oder asynchronem Zustand.
FileStream(String, FileMode, FileAccess, FileShare, Int32, FileOptions)	Initialisiert eine neue Instanz der FileStream Klasse mit dem angegebenen Pfad, Erstellungsmodus, Lese-/Schreibzugriff und Freigabeberechtigung, der Zugriff auf andere FileStreams kann auf dieselbe Datei, die Puffergröße und zusätzliche Dateioptionen verfügen.
FileStream(String, FileStreamOptions)	Initialisiert eine neue Instanz der FileStream Klasse mit dem angegebenen Pfad, Erstellungsmodus, Lese-/Schreib- und Freigabeberechtigungen, Puffergröße, zusätzliche Dateioptionen, Präallocation-Größe und dem Zugriff auf andere FileStreams kann dieselbe Datei haben.

Eigenschaften

CanRead	Ruft einen Wert ab, der angibt, ob der aktuelle Datenstrom das Lesen unterstützt.
CanSeek	Ruft einen Wert ab, der angibt, ob der aktuelle Datenstrom die Suche unterstützt.
CanTimeout	Ruft einen Wert ab, der bestimmt, ob der aktuelle Datenstrom Timeout ausführen kann. (Geerbt von Stream)
CanWrite	Ruft einen Wert ab, der angibt, ob der aktuelle Datenstrom das Schreiben unterstützt.
Handle	Veraltet. Ruft das Betriebssystemdateihandle für die Datei ab, die vom aktuellen FileStream-Objekt gekapselt wird.
IsAsync	Ruft einen Wert ab, der angibt, ob die FileStream asynchron oder synchron geöffnet wurde.
Length	Ruft die Länge in Bytes des Datenstroms ab.
Name	Ruft den absoluten Pfad der Datei, die in der FileStreamgeöffnet wird.
Position	Dient zum Abrufen oder Festlegen der aktuellen Position dieses Datenstroms.
ReadTimeout	Dient zum Abrufen oder Festlegen eines Werts in Millisekunden, der bestimmt, wie lange der Datenstrom vor dem Timeout zu lesen versucht. (Geerbt von Stream)
SafeFileHandle	Ruft ein SafeFileHandle -Objekt, das das Betriebssystemdateihandle für die Datei darstellt, die das aktuelle FileStream -Objekt kapselt.
WriteTimeout	Dient zum Abrufen oder Festlegen eines Werts in Millisekunden, der bestimmt, wie lange der Datenstrom versucht, vor dem Timeout zu schreiben. (Geerbt von Stream)

Methoden

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Startet einen asynchronen Lesevorgang. Verwenden Sie stattdessen ReadAsync(Byte[], Int32, Int32, CancellationToken).
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Startet einen asynchronen Schreibvorgang. Verwenden Sie stattdessen WriteAsync(Byte[], Int32, Int32, CancellationToken).
Close()	Schließt den aktuellen Datenstrom und gibt alle Ressourcen (z. B. Sockets und Dateihandles) frei, die dem aktuellen Datenstrom zugeordnet sind. Anstatt diese Methode aufzurufen, stellen Sie sicher, dass der Datenstrom ordnungsgemäß verworfen ist. (Geerbt von Stream)
CopyTo(Stream)	Liest die Bytes aus dem aktuellen Datenstrom und schreibt sie in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyTo(Stream, Int32)	Liest die Bytes aus dem aktuellen Datenstrom und schreibt sie mithilfe einer angegebenen Puffergröße in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream)	Liest die Bytes asynchron aus dem aktuellen Datenstrom und schreibt sie in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, CancellationToken)	Liest die Bytes asynchron aus dem aktuellen Datenstrom und schreibt sie mithilfe eines angegebenen Abbruchtokens in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, Int32)	Liest die Bytes asynchron aus dem aktuellen Datenstrom und schreibt sie mithilfe einer angegebenen Puffergröße in einen anderen Datenstrom. Beide Datenströme werden um die Anzahl der kopierten Bytes erweitert. (Geerbt von Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Liest asynchron die Bytes aus dem aktuellen Dateidatenstrom und schreibt sie in einen anderen Datenstrom, wobei eine angegebene Puffergröße und ein Abbruchtoken verwendet wird.
CreateObjRef(Type)	Erstellt ein Objekt, das alle relevanten Informationen enthält, die zum Generieren eines Proxys erforderlich sind, der für die Kommunikation mit einem Remoteobjekt verwendet wird. (Geerbt von MarshalByRefObject)
CreateWaitHandle()	Veraltet. Weist ein WaitHandle-Objekt zu. (Geerbt von Stream)
Dispose()	Gibt alle vom Streamverwendeten Ressourcen frei. (Geerbt von Stream)
Dispose(Boolean)	Gibt die nicht verwalteten Ressourcen frei, die vom FileStream verwendet werden, und gibt optional die verwalteten Ressourcen frei.
DisposeAsync()	Gibt asynchron die nicht verwalteten Ressourcen frei, die vom FileStreamverwendet werden.
EndRead(IAsyncResult)	Wartet, bis der ausstehende asynchrone Lesevorgang abgeschlossen ist. (Verwenden Sie stattdessen ReadAsync(Byte[], Int32, Int32, CancellationToken).)
EndWrite(IAsyncResult)	Beendet einen asynchronen Schreibvorgang und blockiert, bis der E/A-Vorgang abgeschlossen ist. (Verwenden Sie stattdessen WriteAsync(Byte[], Int32, Int32, CancellationToken).)
Equals(Object)	Bestimmt, ob das angegebene Objekt dem aktuellen Objekt entspricht. (Geerbt von Object)
Finalize()	Stellt sicher, dass Ressourcen freigegeben werden und andere Bereinigungsvorgänge ausgeführt werden, wenn der Garbage Collector die FileStreamzurückgibt.
Flush()	Löscht Puffer für diesen Datenstrom und bewirkt, dass in die Datei gepufferte Daten geschrieben werden.
Flush(Boolean)	Löscht Puffer für diesen Datenstrom und bewirkt, dass alle gepufferten Daten in die Datei geschrieben werden, und alle Zwischendateipuffer werden gelöscht.
FlushAsync()	Löscht asynchron alle Puffer für diesen Datenstrom und bewirkt, dass alle gepufferten Daten auf das zugrunde liegende Gerät geschrieben werden. (Geerbt von Stream)
FlushAsync(CancellationToken)	Löscht asynchron alle Puffer für diesen Datenstrom, bewirkt, dass alle gepufferten Daten auf das zugrunde liegende Gerät geschrieben werden, und überwacht Abbruchanforderungen.
GetHashCode()	Dient als Standardhashfunktion. (Geerbt von Object)
GetLifetimeService()	Veraltet. Ruft das aktuelle Lebensdauerdienstobjekt ab, das die Lebensdauerrichtlinie für diese Instanz steuert. (Geerbt von MarshalByRefObject)
GetType()	Ruft die Type der aktuellen Instanz ab. (Geerbt von Object)
InitializeLifetimeService()	Veraltet. Ruft ein Lebensdauerdienstobjekt ab, um die Lebensdauerrichtlinie für diese Instanz zu steuern. (Geerbt von MarshalByRefObject)
Lock(Int64, Int64)	Verhindert, dass andere Prozesse in den FileStreamlesen oder schreiben.
MemberwiseClone()	Erstellt eine flache Kopie der aktuellen Object. (Geerbt von Object)
MemberwiseClone(Boolean)	Erstellt eine flache Kopie des aktuellen MarshalByRefObject-Objekts. (Geerbt von MarshalByRefObject)
ObjectInvariant()	Veraltet. Bietet Unterstützung für eine Contract. (Geerbt von Stream)
Read(Byte[], Int32, Int32)	Liest einen Byteblock aus dem Datenstrom und schreibt die Daten in einen bestimmten Puffer.
Read(Span<Byte>)	Liest eine Bytesequenz aus dem aktuellen Dateidatenstrom und wechselt die Position innerhalb des Dateidatenstroms um die Anzahl der gelesenen Bytes.
ReadAsync(Byte[], Int32, Int32)	Liest asynchron eine Abfolge von Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes. (Geerbt von Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Liest asynchron eine Bytesequenz aus dem aktuellen Dateidatenstrom und schreibt sie in ein Bytearray, das mit einem angegebenen Offset beginnt, führt die Position innerhalb des Dateidatenstroms um die Anzahl der gelesenen Bytes und überwacht Abbruchanforderungen.
ReadAsync(Memory<Byte>, CancellationToken)	Liest asynchron eine Abfolge von Bytes aus dem aktuellen Dateidatenstrom und schreibt sie in einen Speicherbereich, wechselt die Position innerhalb des Dateidatenstroms um die Anzahl der gelesenen Bytes und überwacht Abbruchanforderungen.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Liest mindestens eine Minimale Anzahl von Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes. (Geerbt von Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Liest asynchron mindestens eine Mindestanzahl von Bytes aus dem aktuellen Datenstrom, wechselt die Position innerhalb des Datenstroms um die Anzahl der gelesenen Bytes und überwacht Abbruchanforderungen. (Geerbt von Stream)
ReadByte()	Liest ein Byte aus der Datei und wechselt die Leseposition um ein Byte.
ReadExactly(Byte[], Int32, Int32)	Liest count Anzahl von Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms. (Geerbt von Stream)
ReadExactly(Span<Byte>)	Liest Bytes aus dem aktuellen Datenstrom und wechselt die Position innerhalb des Datenstroms, bis die buffer gefüllt ist. (Geerbt von Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Liest asynchron count Anzahl von Bytes aus dem aktuellen Datenstrom, wechselt die Position innerhalb des Datenstroms und überwacht Abbruchanforderungen. (Geerbt von Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Liest asynchron Bytes aus dem aktuellen Datenstrom, wechselt die Position innerhalb des Datenstroms, bis die buffer gefüllt ist, und überwacht Abbruchanforderungen. (Geerbt von Stream)
Seek(Int64, SeekOrigin)	Legt die aktuelle Position dieses Datenstroms auf den angegebenen Wert fest.
SetLength(Int64)	Legt die Länge dieses Datenstroms auf den angegebenen Wert fest.
ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object)
Unlock(Int64, Int64)	Ermöglicht den Zugriff durch andere Prozesse auf eine zuvor gesperrte Datei oder einen Teil einer Datei.
Write(Byte[], Int32, Int32)	Schreibt einen Byteblock in den Dateidatenstrom.
Write(ReadOnlySpan<Byte>)	Schreibt eine Abfolge von Bytes aus einer schreibgeschützten Spanne in den aktuellen Dateidatenstrom und wechselt die aktuelle Position innerhalb dieses Dateidatenstroms um die Anzahl der geschriebenen Bytes.
WriteAsync(Byte[], Int32, Int32)	Schreibt asynchron eine Bytesequenz in den aktuellen Datenstrom und wechselt die aktuelle Position innerhalb dieses Datenstroms um die Anzahl der geschriebenen Bytes. (Geerbt von Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Schreibt asynchron eine Bytesequenz in den aktuellen Datenstrom, wechselt die aktuelle Position innerhalb dieses Datenstroms um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Schreibt asynchron eine Bytesequenz aus einem Speicherbereich in den aktuellen Dateidatenstrom, wechselt die aktuelle Position innerhalb dieses Dateidatenstroms um die Anzahl der geschriebenen Bytes und überwacht Abbruchanforderungen.
WriteByte(Byte)	Schreibt ein Byte an die aktuelle Position im Dateidatenstrom.

Erweiterungsmethoden

GetAccessControl(FileStream)	Gibt die Sicherheitsinformationen einer Datei zurück.
SetAccessControl(FileStream, FileSecurity)	Ändert die Sicherheitsattribute einer vorhandenen Datei.
CopyToAsync(Stream, PipeWriter, CancellationToken)	Liest die Bytes asynchron aus dem Stream und schreibt sie mithilfe eines Abbruchtokens in das angegebene PipeWriter.
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguriert, wie auf die von einem asynchronen Einweg zurückgegebenen Aufgaben gewartet wird.

Weitere Informationen

• File
• FileAccess
• FileMode
• FileShare
• Datei- und Stream-E/A-
• How to: Read Text from a File
• How to: Write Text to a File
• Gewusst wie: Lesen und Schreiben in eine neu erstellte Datendatei