FileStream Classe

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Origem:

FileStream.cs

Fornece um Stream para um arquivo, dando suporte a operações de leitura e gravação síncronas e assíncronas.

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

public class FileStream : System.IO.Stream

type FileStream = class
    inherit Stream

Public Class FileStream
Inherits Stream

Herança

Object

MarshalByRefObject

Stream

FileStream

Derivado

System.IO.IsolatedStorage.IsolatedStorageFileStream

Exemplos

O exemplo a seguir demonstra alguns dos FileStream construtores.

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

O exemplo a seguir mostra como gravar em um arquivo de forma assíncrona. Esse código é executado em um aplicativo WPF que tem um TextBlock chamado UserInput e um botão conectado a um manipulador de eventos Click chamado Button_Click. O caminho do arquivo precisa ser alterado para um arquivo que existe no computador.

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

Comentários

Para obter mais informações sobre essa API, consulte Comentários da API complementar para FileStream.

Construtores

FileStream(IntPtr, FileAccess)	Obsoleto. Inicializa uma nova instância da classe FileStream para o identificador de arquivo especificado, com a permissão de leitura/gravação especificada.
FileStream(IntPtr, FileAccess, Boolean)	Obsoleto. Inicializa uma nova instância da classe FileStream para o identificador de arquivo especificado, com a permissão de leitura/gravação especificada e a propriedade da instância FileStream.
FileStream(IntPtr, FileAccess, Boolean, Int32)	Obsoleto. Inicializa uma nova instância da classe FileStream para o identificador de arquivo especificado, com a permissão de leitura/gravação, a propriedade da instância FileStream e o tamanho do buffer especificados.
FileStream(IntPtr, FileAccess, Boolean, Int32, Boolean)	Obsoleto. Inicializa uma nova instância da classe FileStream para o identificador de arquivo especificado, com a permissão de leitura/gravação, a propriedade da instância FileStream, o tamanho do buffer e o estado síncrono ou assíncrono especificados.
FileStream(SafeFileHandle, FileAccess)	Inicializa uma nova instância da classe FileStream para o identificador de arquivo especificado, com a permissão de leitura/gravação especificada.
FileStream(SafeFileHandle, FileAccess, Int32)	Inicializa uma nova instância da classe FileStream para o identificador de arquivo especificado, com a permissão de leitura/gravação especificada e tamanho do buffer.
FileStream(SafeFileHandle, FileAccess, Int32, Boolean)	Inicializa uma nova instância da classe FileStream para o identificador de arquivo, com a permissão de leitura/gravação, o tamanho do buffer e o estado síncrono ou assíncrono especificados.
FileStream(String, FileMode)	Inicializa uma nova instância da classe FileStream com o modo de criação e o caminho especificados.
FileStream(String, FileMode, FileAccess)	Inicializa uma nova instância da classe FileStream com o caminho, o modo de criação e a permissão de leitura/gravação especificados.
FileStream(String, FileMode, FileAccess, FileShare)	Inicializa uma nova instância da classe FileStream com o caminho especificado, o modo de criação, permissão de leitura/gravação e permissões de compartilhamento.
FileStream(String, FileMode, FileAccess, FileShare, Int32)	Inicializa uma nova instância da classe FileStream com o caminho, o modo de criação, as permissões de leitura/gravação e compartilhamento e o tamanho do buffer especificados.
FileStream(String, FileMode, FileAccess, FileShare, Int32, Boolean)	Inicializa uma nova instância da classe FileStream com o caminho especificado, o modo de criação, leitura/gravação e permissões de compartilhamento, tamanho do buffer e estado síncrono ou assíncrono.
FileStream(String, FileMode, FileAccess, FileShare, Int32, FileOptions)	Inicializa uma nova instância da classe FileStream com o caminho, o modo de criação, a permissão de compartilhamento e leitura/gravação, o acesso que outros FileStreams podem ter ao mesmo arquivo, o tamanho do buffer e as opções de arquivo adicionais especificados.
FileStream(String, FileStreamOptions)	Inicializa uma nova instância da FileStream classe com o caminho especificado, o modo de criação, a permissão de leitura/gravação e compartilhamento, o tamanho do buffer, as opções de arquivo adicionais, o tamanho da pré-localização e o acesso que outros FileStreams podem ter para o mesmo arquivo.

Propriedades

CanRead	Obtém um valor que indica se o fluxo atual dá suporte a leitura.
CanSeek	Obtém um valor que indica se o fluxo atual dá suporte a busca.
CanTimeout	Obtém um valor que determina se o fluxo atual pode atingir o tempo limite. (Herdado de Stream)
CanWrite	Obtém um valor que indica se o fluxo atual dá suporte a gravação.
Handle	Obsoleto. Obtém o identificador de arquivo do sistema operacional do arquivo que o objeto FileStream atual encapsula.
IsAsync	Obtém um valor que indica se FileStream foi aberto de forma assíncrona ou síncrona.
Length	Obtém o tamanho do fluxo em bytes.
Name	Obtém o caminho absoluto do arquivo aberto no FileStream.
Position	Obtém ou define a posição atual desse fluxo.
ReadTimeout	Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará realizar a leitura antes do tempo limite. (Herdado de Stream)
SafeFileHandle	Obtém um objeto SafeFileHandle que representa o identificador de arquivo do sistema operacional para o arquivo que o objeto FileStream atual encapsula.
WriteTimeout	Obtém ou define um valor, em milissegundos, que determina por quanto tempo o fluxo tentará realizar a gravação antes do tempo limite. (Herdado de Stream)

Métodos

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Inicia uma operação de leitura assíncrona. Considere o uso de ReadAsync(Byte[], Int32, Int32, CancellationToken) em seu lugar.
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Inicia uma operação de gravação assíncrona. Considere o uso de WriteAsync(Byte[], Int32, Int32, CancellationToken) em seu lugar.
Close()	Fecha o fluxo atual e libera todos os recursos (como soquetes e identificadores de arquivos) associados ao fluxo atual. Em vez de chamar esse método, verifique se o fluxo é descartado corretamente. (Herdado de Stream)
CopyTo(Stream)	Lê os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (Herdado de Stream)
CopyTo(Stream, Int32)	Lê os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (Herdado de Stream)
CopyToAsync(Stream)	Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (Herdado de Stream)
CopyToAsync(Stream, CancellationToken)	Lê de forma assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um token de cancelamento especificado. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (Herdado de Stream)
CopyToAsync(Stream, Int32)	Lê de maneira assíncrona os bytes do fluxo atual e os grava em outro fluxo usando um tamanho do buffer especificado. Ambas as posições de fluxo são avançadas pelo número de bytes copiados. (Herdado de Stream)
CopyToAsync(Stream, Int32, CancellationToken)	Lê de forma assíncrona os bytes do fluxo de arquivo atual e grava-os em outro fluxo usando um tamanho do buffer especificado e um token de cancelamento.
CreateObjRef(Type)	Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto. (Herdado de MarshalByRefObject)
CreateWaitHandle()	Obsoleto. Aloca um objeto WaitHandle. (Herdado de Stream)
Dispose()	Libera todos os recursos usados pelo Stream. (Herdado de Stream)
Dispose(Boolean)	Libera os recursos não gerenciados usados pelo FileStream e opcionalmente libera os recursos gerenciados.
DisposeAsync()	Libera de forma assíncrona os recursos não gerenciados usados pelo FileStream.
EndRead(IAsyncResult)	Aguarda a operação de leitura assíncrona pendente ser concluída. (Considere o uso de ReadAsync(Byte[], Int32, Int32, CancellationToken) em seu lugar.)
EndWrite(IAsyncResult)	Termina uma operação de gravação assíncrona e bloqueia até que a operação de E/S seja concluída. (Considere o uso de WriteAsync(Byte[], Int32, Int32, CancellationToken) em seu lugar.)
Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
Finalize()	Garante que os recursos são liberados e outras operações de limpeza são executadas quando o coletor de lixo recupera o objeto FileStream.
Flush()	Limpa os buffers desse fluxo e faz com que todos os dados armazenados em buffer sejam gravados no arquivo.
Flush(Boolean)	Limpa os buffers desse fluxo e faz com que os dados armazenados em buffer sejam gravados no arquivo e também limpa todos os buffers de arquivo intermediário.
FlushAsync()	Limpa de forma assíncrona todos os buffers nesse fluxo e faz com que os dados armazenados em buffer sejam gravados no dispositivo subjacente. (Herdado de Stream)
FlushAsync(CancellationToken)	Limpa todos os buffers nesse fluxo de forma assíncrona, faz com que os dados armazenados em buffer sejam gravados no dispositivo subjacente e monitora as solicitações de cancelamento.
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetLifetimeService()	Obsoleto. Recupera o objeto de serviço de tempo de vida atual que controla a política de ciclo de vida para esta instância. (Herdado de MarshalByRefObject)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
InitializeLifetimeService()	Obsoleto. Obtém um objeto de serviço de tempo de vida para controlar a política de tempo de vida para essa instância. (Herdado de MarshalByRefObject)
Lock(Int64, Int64)	Impede que outros processos façam a leitura ou gravação no FileStream.
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
MemberwiseClone(Boolean)	Cria uma cópia superficial do objeto MarshalByRefObject atual. (Herdado de MarshalByRefObject)
ObjectInvariant()	Obsoleto. Oferece suporte a um Contract. (Herdado de Stream)
Read(Byte[], Int32, Int32)	Lê um bloco de bytes do fluxo e grava os dados em um buffer específico.
Read(Span<Byte>)	Lê uma sequência de bytes do fluxo de arquivo atual e avança a posição no fluxo de arquivo até o número de bytes lidos.
ReadAsync(Byte[], Int32, Int32)	Lê uma sequência de bytes do fluxo atual de forma assíncrona e avança a posição no fluxo até o número de bytes lidos. (Herdado de Stream)
ReadAsync(Byte[], Int32, Int32, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo de arquivo atual, grava-os em uma matriz de bytes começando no deslocamento especificado, avança a posição no fluxo de arquivo até o número de bytes lidos e monitora as solicitações de cancelamento.
ReadAsync(Memory<Byte>, CancellationToken)	Lê de forma assíncrona uma sequência de bytes do fluxo de arquivo atual e grava-os em uma região de memória, avança a posição no fluxo de arquivo até o número de bytes lidos e monitora as solicitações de cancelamento.
ReadAtLeast(Span<Byte>, Int32, Boolean)	Lê pelo menos um número mínimo de bytes do fluxo atual e avança a posição dentro do fluxo pelo número de bytes lidos. (Herdado de Stream)
ReadAtLeastAsync(Memory<Byte>, Int32, Boolean, CancellationToken)	Lê de forma assíncrona pelo menos um número mínimo de bytes do fluxo atual, avança a posição dentro do fluxo pelo número de bytes lidos e monitora solicitações de cancelamento. (Herdado de Stream)
ReadByte()	Lê um byte do arquivo e avança a posição de leitura em um byte.
ReadExactly(Byte[], Int32, Int32)	Lê count o número de bytes do fluxo atual e avança a posição dentro do fluxo. (Herdado de Stream)
ReadExactly(Span<Byte>)	Lê bytes do fluxo atual e avança a posição dentro do fluxo até que o buffer seja preenchido. (Herdado de Stream)
ReadExactlyAsync(Byte[], Int32, Int32, CancellationToken)	Lê count de forma assíncrona o número de bytes do fluxo atual, avança a posição dentro do fluxo e monitora as solicitações de cancelamento. (Herdado de Stream)
ReadExactlyAsync(Memory<Byte>, CancellationToken)	Lê bytes de forma assíncrona do fluxo atual, avança a posição dentro do fluxo até que o buffer seja preenchido e monitora as solicitações de cancelamento. (Herdado de Stream)
Seek(Int64, SeekOrigin)	Define a posição atual do fluxo para o valor especificado.
SetLength(Int64)	Define o tamanho deste fluxo para o valor especificado.
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)
Unlock(Int64, Int64)	Permite o acesso por outros processos a todo ou parte de um arquivo que foi bloqueado anteriormente.
Write(Byte[], Int32, Int32)	Grava um bloco de bytes no fluxo de arquivo.
Write(ReadOnlySpan<Byte>)	Grava uma sequência de bytes de um intervalo somente leitura no fluxo de arquivo atual e avança a posição atual nesse fluxo de arquivo até o número de bytes gravados.
WriteAsync(Byte[], Int32, Int32)	Grava assincronamente uma sequência de bytes no fluxo atual e avança a posição atual dentro desse fluxo no número de bytes gravados. (Herdado de Stream)
WriteAsync(Byte[], Int32, Int32, CancellationToken)	Grava uma sequência de bytes no fluxo atual assincronamente, avança a posição atual dentro desse fluxo pelo número de bytes gravados e monitora as solicitações de cancelamento.
WriteAsync(ReadOnlyMemory<Byte>, CancellationToken)	Grava de forma assíncrona uma sequência de bytes de uma região de memória no fluxo de arquivo atual, avança a posição atual nesse fluxo de arquivo até o número de bytes gravados e monitora as solicitações de cancelamento.
WriteByte(Byte)	Grava um byte na posição atual no fluxo de arquivos.

Métodos de Extensão

GetAccessControl(FileStream)	Retorna as informações de segurança de um arquivo.
SetAccessControl(FileStream, FileSecurity)	Altera os atributos de segurança de um arquivo existente.
ConfigureAwait(IAsyncDisposable, Boolean)	Configura como as esperas nas tarefas retornadas de um descartável assíncrono são realizadas.

Confira também

• File
• FileAccess
• FileMode
• FileShare
• E/S de arquivo e de fluxo
• Como ler texto de um arquivo
• Como gravar texto em um arquivo
• Como ler e gravar em um arquivo de dados recém-criado