FileStream Klasa

Definicja

Przestrzeń nazw:

System.IO

Zestaw:

System.Runtime.dll

Źródło:

FileStream.cs

Udostępnia Stream dla pliku, które obsługują zarówno operacje synchroniczne, jak i asynchroniczne operacji odczytu i zapisu.

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

public class FileStream : System.IO.Stream

type FileStream = class
    inherit Stream

Public Class FileStream
Inherits Stream

Dziedziczenie

Object

MarshalByRefObject

Stream

FileStream

Pochodne

System.IO.IsolatedStorage.IsolatedStorageFileStream

Przykłady

W poniższym przykładzie pokazano niektóre konstruktory 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

W poniższym przykładzie pokazano, jak zapisywać w pliku asynchronicznie. Ten kod jest uruchamiany w aplikacji WPF, która ma element TextBlock o nazwie UserInput i przycisk podłączony do programu obsługi zdarzeń Click o nazwie Button_Click. Ścieżka pliku musi zostać zmieniona na plik, który istnieje na komputerze.

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

Uwagi

Aby uzyskać więcej informacji na temat tego interfejsu API, zobacz uwagi dotyczące dodatkowego interfejsu API dla elementu FileStream.

Konstruktory

FileStream(IntPtr, FileAccess)	Przestarzałe. Inicjuje nowe wystąpienie klasy FileStream dla określonego uchwytu pliku z określonym uprawnieniem do odczytu/zapisu.
FileStream(IntPtr, FileAccess, Boolean)	Przestarzałe. Inicjuje nowe wystąpienie klasy FileStream dla określonego dojścia pliku z określonym uprawnieniem do odczytu/zapisu i własnością wystąpienia FileStream.
FileStream(IntPtr, FileAccess, Boolean, Int32)	Przestarzałe. Inicjuje nowe wystąpienie klasy FileStream dla określonego dojścia pliku z określonym uprawnieniem do odczytu/zapisu, FileStream własności wystąpienia i rozmiarem buforu.
FileStream(IntPtr, FileAccess, Boolean, Int32, Boolean)	Przestarzałe. Inicjuje nowe wystąpienie klasy FileStream dla określonego dojścia pliku z określonym uprawnieniem do odczytu/zapisu, FileStream własność wystąpienia, rozmiar buforu i stan synchroniczny lub asynchroniczny.
FileStream(SafeFileHandle, FileAccess)	Inicjuje nowe wystąpienie klasy FileStream dla określonego uchwytu pliku z określonym uprawnieniem do odczytu/zapisu.
FileStream(SafeFileHandle, FileAccess, Int32)	Inicjuje nowe wystąpienie klasy FileStream dla określonego uchwytu pliku z określonym uprawnieniem do odczytu/zapisu i rozmiarem buforu.
FileStream(SafeFileHandle, FileAccess, Int32, Boolean)	Inicjuje nowe wystąpienie klasy FileStream dla określonego uchwytu pliku z określonym uprawnieniem do odczytu/zapisu, rozmiarem buforu i stanem synchronicznym lub asynchronicznym.
FileStream(String, FileMode)	Inicjuje nowe wystąpienie klasy FileStream z określoną ścieżką i trybem tworzenia.
FileStream(String, FileMode, FileAccess)	Inicjuje nowe wystąpienie klasy FileStream z określoną ścieżką, trybem tworzenia i uprawnieniem do odczytu/zapisu.
FileStream(String, FileMode, FileAccess, FileShare)	Inicjuje nowe wystąpienie klasy FileStream z określoną ścieżką, trybem tworzenia, uprawnieniem do odczytu/zapisu i uprawnieniem do udostępniania.
FileStream(String, FileMode, FileAccess, FileShare, Int32)	Inicjuje nowe wystąpienie klasy FileStream z określoną ścieżką, trybem tworzenia, uprawnieniem do odczytu/zapisu i udostępniania oraz rozmiarem buforu.
FileStream(String, FileMode, FileAccess, FileShare, Int32, Boolean)	Inicjuje nowe wystąpienie klasy FileStream z określoną ścieżką, trybem tworzenia, uprawnieniem do odczytu/zapisu i udostępniania, rozmiarem buforu oraz stanem synchronicznym lub asynchronicznym.
FileStream(String, FileMode, FileAccess, FileShare, Int32, FileOptions)	Inicjuje nowe wystąpienie klasy FileStream z określoną ścieżką, trybem tworzenia, uprawnieniami do odczytu/zapisu i udostępniania, dostęp do innych strumieni plików może być musiał mieć ten sam plik, rozmiar buforu i dodatkowe opcje plików.
FileStream(String, FileStreamOptions)	Inicjuje nowe wystąpienie klasy FileStream z określoną ścieżką, trybem tworzenia, uprawnieniem do odczytu/zapisu i udostępniania, rozmiarem buforu, dodatkowymi opcjami plików, rozmiarem wstępnegolokowania i dostępem do innych strumieni plików może być konieczne do tego samego pliku.

Właściwości

CanRead	Pobiera wartość wskazującą, czy bieżący strumień obsługuje odczyt.
CanSeek	Pobiera wartość wskazującą, czy bieżący strumień obsługuje wyszukiwanie.
CanTimeout	Pobiera wartość określającą, czy bieżący strumień może upłynął limit czasu. (Odziedziczone po Stream)
CanWrite	Pobiera wartość wskazującą, czy bieżący strumień obsługuje zapisywanie.
Handle	Przestarzałe. Pobiera uchwyt pliku systemu operacyjnego dla pliku, który jest hermetyzowany przez bieżący obiekt FileStream.
IsAsync	Pobiera wartość wskazującą, czy FileStream został otwarty asynchronicznie lub synchronicznie.
Length	Pobiera długość w bajtach strumienia.
Name	Pobiera ścieżkę bezwzględną pliku otwartego w FileStream.
Position	Pobiera lub ustawia bieżącą pozycję tego strumienia.
ReadTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień będzie próbował odczytać przed upływem limitu czasu. (Odziedziczone po Stream)
SafeFileHandle	Pobiera obiekt SafeFileHandle reprezentujący uchwyt pliku systemu operacyjnego dla pliku, który jest hermetyzowany przez bieżący obiekt FileStream.
WriteTimeout	Pobiera lub ustawia wartość w milisekundach, która określa, jak długo strumień będzie próbował zapisać przed upływem limitu czasu. (Odziedziczone po Stream)

Metody

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna operację odczytu asynchronicznego. Rozważ użycie ReadAsync(Byte[], Int32, Int32, CancellationToken) zamiast tego.
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Rozpoczyna asynchroniczną operację zapisu. Rozważ użycie WriteAsync(Byte[], Int32, Int32, CancellationToken) zamiast tego.
Close()	Zamyka bieżący strumień i zwalnia wszystkie zasoby (takie jak gniazda i dojścia plików) skojarzone z bieżącym strumieniem. Zamiast wywoływać tę metodę, upewnij się, że strumień jest prawidłowo usuwany. (Odziedziczone po Stream)
CopyTo(Stream)	Odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyTo(Stream, Int32)	Odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego tokenu anulowania. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32)	Asynchronicznie odczytuje bajty z bieżącego strumienia i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu. Obie pozycje strumieni są zaawansowane przez liczbę skopiowanych bajtów. (Odziedziczone po Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia plików i zapisuje je w innym strumieniu przy użyciu określonego rozmiaru buforu i tokenu anulowania.
CreateObjRef(Type)	Tworzy obiekt zawierający wszystkie istotne informacje wymagane do wygenerowania serwera proxy używanego do komunikowania się z obiektem zdalnym. (Odziedziczone po MarshalByRefObject)
CreateWaitHandle()	Przestarzałe. Przydziela obiekt WaitHandle. (Odziedziczone po Stream)
Dispose()	Zwalnia wszystkie zasoby używane przez Stream. (Odziedziczone po Stream)
Dispose(Boolean)	Zwalnia niezarządzane zasoby używane przez FileStream i opcjonalnie zwalnia zarządzane zasoby.
DisposeAsync()	Asynchronicznie zwalnia niezarządzane zasoby używane przez FileStream.
EndRead(IAsyncResult)	Oczekuje na ukończenie oczekującej operacji odczytu asynchronicznego. (Rozważ użycie ReadAsync(Byte[], Int32, Int32, CancellationToken) zamiast tego).
EndWrite(IAsyncResult)	Kończy operację zapisu asynchronicznego i blokuje operację we/wy do momentu zakończenia operacji we/wy. (Rozważ użycie WriteAsync(Byte[], Int32, Int32, CancellationToken) zamiast tego).
Equals(Object)	Określa, czy określony obiekt jest równy bieżącemu obiektowi. (Odziedziczone po Object)
Finalize()	Gwarantuje, że zasoby są zwalniane, a inne operacje czyszczenia są wykonywane, gdy moduł odśmiecający elementy bezużyteczne odzyska FileStream.
Flush()	Czyści dla tego strumienia i powoduje zapisanie wszystkich buforowanych danych do pliku.
Flush(Boolean)	Czyści dla tego strumienia i powoduje zapisanie wszystkich buforowanych danych do pliku, a także czyści wszystkie pośrednie plików.
FlushAsync()	Asynchronicznie czyści wszystkie dla tego strumienia i powoduje zapisanie wszystkich buforowanych danych na urządzeniu bazowym. (Odziedziczone po Stream)
FlushAsync(CancellationToken)	Asynchronicznie czyści wszystkie dla tego strumienia, powoduje zapisanie wszystkich buforowanych danych na urządzeniu źródłowym i monitorowanie żądań anulowania.
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetLifetimeService()	Przestarzałe. Pobiera bieżący obiekt usługi okresu istnienia, który kontroluje zasady okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
GetType()	Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object)
InitializeLifetimeService()	Przestarzałe. Uzyskuje obiekt usługi okresu istnienia w celu kontrolowania zasad okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject)
Lock(Int64, Int64)	Zapobiega odczytywaniu lub zapisywaniu innych procesów w FileStream.
MemberwiseClone()	Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object)
MemberwiseClone(Boolean)	Tworzy płytkią kopię bieżącego obiektu MarshalByRefObject. (Odziedziczone po MarshalByRefObject)
ObjectInvariant()	Przestarzałe. Zapewnia obsługę Contract. (Odziedziczone po Stream)
Read(Byte[], Int32, Int32)	Odczytuje blok bajtów ze strumienia i zapisuje dane w danym buforze.
Read(Span<Byte>)	Odczytuje sekwencję bajtów z bieżącego strumienia plików i rozwija pozycję w strumieniu plików przez liczbę odczytanych bajtów.
ReadAsync(Byte[], Int32, Int32)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia plików i zapisuje je w tablicy bajtów rozpoczynającej się od określonego przesunięcia, przesuwa pozycję w strumieniu plików o liczbę odczytanych bajtów i monitoruje żądania anulowania.
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje sekwencję bajtów z bieżącego strumienia plików i zapisuje je w regionie pamięci, przesuwa pozycję w strumieniu plików o liczbę odczytanych bajtów i monitoruje żądania anulowania.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu według liczby odczytanych bajtów. (Odziedziczone po Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronicznie odczytuje co najmniej minimalną liczbę bajtów z bieżącego strumienia, zwiększa pozycję w strumieniu przez liczbę odczytanych bajtów i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadByte()	Odczytuje bajt z pliku i rozwija pozycję odczytu o jeden bajt.
ReadExactly(Byte[], Int32, Int32)	Odczytuje count liczbę bajtów z bieżącego strumienia i rozwija pozycję w strumieniu. (Odziedziczone po Stream)
ReadExactly(Span<Byte>)	Odczytuje bajty z bieżącego strumienia i przesuwa pozycję w strumieniu do momentu wypełnienia buffer. (Odziedziczone po Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie odczytuje count liczbę bajtów z bieżącego strumienia, zwiększa pozycję w strumieniu i monitoruje żądania anulowania. (Odziedziczone po Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronicznie odczytuje bajty z bieżącego strumienia, przechodzi pozycję w strumieniu do momentu wypełnienia buffer i monitoruje żądania anulowania. (Odziedziczone po Stream)
Seek(Int64, SeekOrigin)	Ustawia bieżące położenie tego strumienia na daną wartość.
SetLength(Int64)	Ustawia długość tego strumienia na daną wartość.
ToString()	Zwraca ciąg reprezentujący bieżący obiekt. (Odziedziczone po Object)
Unlock(Int64, Int64)	Umożliwia dostęp przez inne procesy do wszystkich lub części pliku, który został wcześniej zablokowany.
Write(Byte[], Int32, Int32)	Zapisuje blok bajtów w strumieniu plików.
Write(ReadOnlySpan<Byte>)	Zapisuje sekwencję bajtów z zakresu tylko do odczytu do bieżącego strumienia plików i przechodzi bieżącą pozycję w tym strumieniu plików przez liczbę zapisanych bajtów.
WriteAsync(Byte[], Int32, Int32)	Asynchronicznie zapisuje sekwencję bajtów do bieżącego strumienia i przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów. (Odziedziczone po Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronicznie zapisuje sekwencję bajtów w bieżącym strumieniu, przechodzi bieżącą pozycję w tym strumieniu przez liczbę zapisanych bajtów i monitoruje żądania anulowania.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronicznie zapisuje sekwencję bajtów z regionu pamięci do bieżącego strumienia plików, przechodzi bieżącą pozycję w tym strumieniu plików przez liczbę zapisanych bajtów i monitoruje żądania anulowania.
WriteByte(Byte)	Zapisuje bajt do bieżącej pozycji w strumieniu plików.

Metody rozszerzania

GetAccessControl(FileStream)	Zwraca informacje o zabezpieczeniach pliku.
SetAccessControl(FileStream, FileSecurity)	Zmienia atrybuty zabezpieczeń istniejącego pliku.
CopyToAsync(Stream, PipeWriter, CancellationToken)	Asynchronicznie odczytuje bajty z Stream i zapisuje je w określonym PipeWriterprzy użyciu tokenu anulowania.
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguruje, w jaki sposób będą wykonywane oczekiwania na zadania zwrócone z asynchronicznego jednorazowego użytku.

Zobacz też

• File
• FileAccess
• FileMode
• FileShare
• plików i strumienia we/wy
• Instrukcje: odczytywanie tekstu z pliku
• Instrukcje: zapisywanie tekstu w pliku
• Instrukcje: odczytywanie i zapisywanie w nowo utworzonym pliku danych