FileStream Třída

Definice

Obor názvů:

System.IO

Sestavení:

System.Runtime.dll

Zdroj:

FileStream.cs

Stream Poskytuje pro soubor, který podporuje synchronní i asynchronní operace čtení a zápisu.

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

public class FileStream : System.IO.Stream

type FileStream = class
    inherit Stream

Public Class FileStream
Inherits Stream

Dědičnost

Object

MarshalByRefObject

Stream

FileStream

Odvozené

System.IO.IsolatedStorage.IsolatedStorageFileStream

Příklady

Následující příklad ukazuje některé 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

Následující příklad ukazuje, jak zapisovat do souboru asynchronně. Tento kód běží v aplikaci WPF, která má TextBlock s názvem UserInput a tlačítko připojená k obslužné rutině události Click s názvem Button_Click. Cestu k souboru je potřeba změnit na soubor, který v počítači existuje.

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

Poznámky

Další informace o tomto rozhraní API najdete v tématu Doplňkové poznámky rozhraní API pro FileStream.

Konstruktory

FileStream(IntPtr, FileAccess)	Zastaralé. Inicializuje novou instanci FileStream třídy pro zadaný popisovač souboru se zadaným oprávněním pro čtení a zápis.
FileStream(IntPtr, FileAccess, Boolean)	Zastaralé. Inicializuje novou instanci FileStream třídy pro zadaný popisovač souboru se zadaným oprávněním pro čtení/zápis a FileStream vlastnictví instance.
FileStream(IntPtr, FileAccess, Boolean, Int32)	Zastaralé. Inicializuje novou instanci FileStream třídy pro zadaný popisovač souboru se zadaným oprávněním pro čtení a zápis, FileStream vlastnictví instance a velikost vyrovnávací paměti.
FileStream(IntPtr, FileAccess, Boolean, Int32, Boolean)	Zastaralé. Inicializuje novou instanci FileStream třídy pro zadaný popisovač souboru se zadaným oprávněním pro čtení a zápis, FileStream vlastnictví instance, velikost vyrovnávací paměti a synchronní nebo asynchronní stav.
FileStream(SafeFileHandle, FileAccess)	Inicializuje novou instanci FileStream třídy pro zadaný popisovač souboru se zadaným oprávněním pro čtení a zápis.
FileStream(SafeFileHandle, FileAccess, Int32)	Inicializuje novou instanci FileStream třídy pro zadaný popisovač souboru se zadaným oprávněním pro čtení a zápis a velikost vyrovnávací paměti.
FileStream(SafeFileHandle, FileAccess, Int32, Boolean)	Inicializuje novou instanci FileStream třídy pro zadaný popisovač souboru se zadaným oprávněním pro čtení/zápis, velikost vyrovnávací paměti a synchronním nebo asynchronním stavem.
FileStream(String, FileMode)	Inicializuje novou instanci FileStream třídy se zadanou cestou a režimem vytváření.
FileStream(String, FileMode, FileAccess)	Inicializuje novou instanci FileStream třídy se zadanou cestou, režimem vytváření a oprávněním pro čtení a zápis.
FileStream(String, FileMode, FileAccess, FileShare)	Inicializuje novou instanci FileStream třídy se zadanou cestou, režimem vytváření, oprávněním ke čtení a zápisu a oprávněním ke sdílení.
FileStream(String, FileMode, FileAccess, FileShare, Int32)	Inicializuje novou instanci FileStream třídy se zadanou cestou, režimem vytváření, oprávněním ke čtení/zápisu a sdílení a velikostí vyrovnávací paměti.
FileStream(String, FileMode, FileAccess, FileShare, Int32, Boolean)	Inicializuje novou instanci FileStream třídy se zadanou cestou, režimem vytváření, oprávněním ke čtení/zápisu a sdílení, velikost vyrovnávací paměti a synchronním nebo asynchronním stavem.
FileStream(String, FileMode, FileAccess, FileShare, Int32, FileOptions)	Inicializuje novou instanci FileStream třídy se zadanou cestou, režimem vytváření, oprávněním ke čtení/zápisu a sdílení, přístup ke stejnému souboru, velikosti vyrovnávací paměti a dalším možnostem souboru.
FileStream(String, FileStreamOptions)	Inicializuje novou instanci FileStream třídy se zadanou cestou, režimem vytváření, oprávněním ke čtení/zápisu a sdílení, velikostí vyrovnávací paměti, dalšími možnostmi souboru, velikostí předlokace a přístupem ke stejnému souboru mohou mít ostatní streamy souborů.

Vlastnosti

CanRead	Získá hodnotu, která označuje, zda aktuální datový proud podporuje čtení.
CanSeek	Získá hodnotu, která označuje, zda aktuální datový proud podporuje hledání.
CanTimeout	Získá hodnotu, která určuje, zda aktuální datový proud může vypršení časového limitu. (Zděděno od Stream)
CanWrite	Získá hodnotu, která označuje, zda aktuální datový proud podporuje zápis.
Handle	Zastaralé. Získá popisovač souboru operačního systému pro soubor, který aktuální FileStream objekt zapouzdřuje.
IsAsync	Získá hodnotu, která označuje, zda FileStream byl otevřen asynchronně nebo synchronně.
Length	Získá délku v bajtech datového proudu.
Name	Získá absolutní cestu souboru otevřeného v objektu FileStream.
Position	Získá nebo nastaví aktuální pozici tohoto datového proudu.
ReadTimeout	Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí číst před vypršením časového limitu. (Zděděno od Stream)
SafeFileHandle	SafeFileHandle Získá objekt, který představuje popisovač souboru operačního systému pro soubor, který aktuální FileStream objekt zapouzdřuje.
WriteTimeout	Získá nebo nastaví hodnotu v milisekundách, která určuje, jak dlouho se datový proud pokusí zapisovat před vypršením časového limitu. (Zděděno od Stream)

Metody

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Zahájí asynchronní operaci čtení. Zvažte místo toho použití ReadAsync(Byte[], Int32, Int32, CancellationToken) .
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Zahájí asynchronní operaci zápisu. Zvažte místo toho použití WriteAsync(Byte[], Int32, Int32, CancellationToken) .
Close()	Zavře aktuální datový proud a uvolní všechny prostředky (například sokety a popisovače souborů) přidružené k aktuálnímu datovému proudu. Místo volání této metody se ujistěte, že datový proud je správně odstraněn. (Zděděno od Stream)
CopyTo(Stream)	Přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyTo(Stream, Int32)	Načte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu s použitím zadané velikosti vyrovnávací paměti. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream)	Asynchronně čte bajty z aktuálního datového proudu a zapisuje je do jiného datového proudu. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, CancellationToken)	Asynchronně přečte bajty z aktuálního datového proudu a zapíše je do jiného datového proudu pomocí zadaného tokenu zrušení. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, Int32)	Asynchronně čte bajty z aktuálního datového proudu a zapisuje je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti. Obě pozice datových proudů se posouvají podle počtu zkopírovaných bajtů. (Zděděno od Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Asynchronně přečte bajty z aktuálního datového proudu souboru a zapíše je do jiného datového proudu pomocí zadané velikosti vyrovnávací paměti a tokenu zrušení.
CreateObjRef(Type)	Vytvoří objekt, který obsahuje všechny relevantní informace potřebné k vygenerování proxy sloužící ke komunikaci se vzdáleným objektem. (Zděděno od MarshalByRefObject)
CreateWaitHandle()	Zastaralé. Přidělí WaitHandle objekt. (Zděděno od Stream)
Dispose()	Uvolní všechny prostředky používané nástrojem Stream. (Zděděno od Stream)
Dispose(Boolean)	Uvolní nespravované prostředky používané nástrojem FileStream a volitelně uvolní spravované prostředky.
DisposeAsync()	Asynchronně uvolní nespravované prostředky, které FileStreampoužívá .
EndRead(IAsyncResult)	Čeká na dokončení čekající asynchronní operace čtení. (Zvažte místo toho použití ReadAsync(Byte[], Int32, Int32, CancellationToken) .)
EndWrite(IAsyncResult)	Ukončí asynchronní operaci zápisu a blokuje ji, dokud se neskončí vstupně-výstupní operace. (Zvažte místo toho použití WriteAsync(Byte[], Int32, Int32, CancellationToken) .)
Equals(Object)	Určí, zda se zadaný objekt rovná aktuálnímu objektu. (Zděděno od Object)
Finalize()	Zajišťuje uvolnění prostředků a provádění dalších operací čištění, když systém uvolňování paměti uvolní FileStream.
Flush()	Vymaže vyrovnávací paměti pro tento datový proud a způsobí zápis všech dat do vyrovnávací paměti do souboru.
Flush(Boolean)	Vymaže vyrovnávací paměti pro tento datový proud a způsobí zápis všech dat do vyrovnávací paměti do souboru a také vymaže všechny přechodné vyrovnávací paměti souborů.
FlushAsync()	Asynchronně vymaže všechny vyrovnávací paměti pro tento datový proud a způsobí zápis všech dat do vyrovnávací paměti do základního zařízení. (Zděděno od Stream)
FlushAsync(CancellationToken)	Asynchronně vymaže všechny vyrovnávací paměti pro tento datový proud, způsobí zápis všech dat do vyrovnávací paměti do základního zařízení a monitoruje požadavky na zrušení.
GetHashCode()	Slouží jako výchozí hashovací funkce. (Zděděno od Object)
GetLifetimeService()	Zastaralé. Načte aktuální životnost objektu služby, který řídí zásady životnosti pro tuto instanci. (Zděděno od MarshalByRefObject)
GetType()	Type Získá z aktuální instance. (Zděděno od Object)
InitializeLifetimeService()	Zastaralé. Získá životnost objektu služby, který řídí zásady životnosti pro tuto instanci. (Zděděno od MarshalByRefObject)
Lock(Int64, Int64)	Brání jiným procesům ve čtení z nebo zápisu do .FileStream
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Objectsouboru . (Zděděno od Object)
MemberwiseClone(Boolean)	Vytvoří mělkou kopii aktuálního MarshalByRefObject objektu. (Zděděno od MarshalByRefObject)
ObjectInvariant()	Zastaralé. Poskytuje podporu pro Contract. (Zděděno od Stream)
Read(Byte[], Int32, Int32)	Načte blok bajtů z datového proudu a zapíše data do dané vyrovnávací paměti.
Read(Span<Byte>)	Přečte posloupnost bajtů z aktuálního datového proudu souboru a posune pozici v datovém proudu souboru o počet přečtených bajtů.
ReadAsync(Byte[], Int32, Int32)	Asynchronně přečte posloupnost bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu o počet přečtených bajtů. (Zděděno od Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně přečte sekvenci bajtů z aktuálního datového proudu souboru a zapíše je do pole bajtů počínaje zadaným posunem, posune pozici v datovém proudu souboru o počet přečtených bajtů a sleduje požadavky na zrušení.
ReadAsync(Memory<Byte>, CancellationToken)	Asynchronně přečte sekvenci bajtů z aktuálního datového proudu souboru a zapíše je do oblasti paměti, posune pozici v datovém proudu souboru o počet přečtených bajtů a sleduje požadavky na zrušení.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Přečte alespoň minimální počet bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu o počet přečtených bajtů. (Zděděno od Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Asynchronně přečte alespoň minimální počet bajtů z aktuálního datového proudu, posune pozici v rámci datového proudu o počet přečtených bajtů a sleduje požadavky na zrušení. (Zděděno od Stream)
ReadByte()	Přečte bajt ze souboru a posune pozici čtení o jeden bajt.
ReadExactly(Byte[], Int32, Int32)	Načte count počet bajtů z aktuálního datového proudu a posune pozici v rámci datového proudu. (Zděděno od Stream)
ReadExactly(Span<Byte>)	Načte bajty z aktuálního datového proudu a posune pozici v rámci datového proudu, dokud buffer není vyplněna. (Zděděno od Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně načte count počet bajtů z aktuálního datového proudu, posune pozici v rámci datového proudu a monitoruje požadavky na zrušení. (Zděděno od Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Asynchronně čte bajty z aktuálního datového proudu, posune pozici v rámci datového proudu až do buffer vyplnění a monitoruje žádosti o zrušení. (Zděděno od Stream)
Seek(Int64, SeekOrigin)	Nastaví aktuální pozici tohoto datového proudu na danou hodnotu.
SetLength(Int64)	Nastaví délku tohoto datového proudu na danou hodnotu.
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)
Unlock(Int64, Int64)	Umožňuje jiným procesům přístup k celému souboru nebo jeho části, který byl dříve uzamčen.
Write(Byte[], Int32, Int32)	Zapíše blok bajtů do datového proudu souboru.
Write(ReadOnlySpan<Byte>)	Zapíše posloupnost bajtů z rozsahu jen pro čtení do aktuálního datového proudu souboru a posune aktuální pozici v tomto datovém proudu souboru o počet zapsaných bajtů.
WriteAsync(Byte[], Int32, Int32)	Asynchronně zapíše posloupnost bajtů do aktuálního datového proudu a posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů. (Zděděno od Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Asynchronně zapíše sekvenci bajtů do aktuálního datového proudu, posune aktuální pozici v rámci tohoto datového proudu o počet zapsaných bajtů a sleduje požadavky na zrušení.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Asynchronně zapíše sekvenci bajtů z oblasti paměti do aktuálního datového proudu souboru, posune aktuální pozici v rámci tohoto datového proudu souboru o počet zapsaných bajtů a monitoruje požadavky na zrušení.
WriteByte(Byte)	Zapíše bajt na aktuální pozici v datovém proudu souboru.

Metody rozšíření

GetAccessControl(FileStream)	Vrátí informace o zabezpečení souboru.
SetAccessControl(FileStream, FileSecurity)	Změní atributy zabezpečení existujícího souboru.
ConfigureAwait(IAsyncDisposable, Boolean)	Konfiguruje, jak se provádí funkce awaits u úloh vrácených z asynchronního jednorázového režimu.

Viz také

• File
• FileAccess
• FileMode
• FileShare
• Vstupně-výstupní operace souborů a datových proudů
• Postupy: Čtení textu ze souboru
• Postupy: Zápis textu do souboru
• Postupy: Čtení a zápis do nově vytvořeného datového souboru