File.WriteAllText Método

Definição

Namespace:

System.IO

Assembly:

System.Runtime.dll

Cria um novo arquivo, grava o conteúdo no arquivo e fecha o arquivo. Se o arquivo de destino já existir, ele será truncado e substituído.

Sobrecargas

WriteAllText(String, String)	Cria um novo arquivo, grava a cadeia de caracteres especificada no arquivo e fecha o arquivo. Se o arquivo de destino já existir, ele será truncado e substituído.
WriteAllText(String, String, Encoding)	Cria um novo arquivo, grava a cadeia de caracteres especificada no arquivo usando a codificação especificada e fecha o arquivo. Se o arquivo de destino já existir, ele será truncado e substituído.

WriteAllText(String, String)

Origem:

File.cs

Cria um novo arquivo, grava a cadeia de caracteres especificada no arquivo e fecha o arquivo. Se o arquivo de destino já existir, ele será truncado e substituído.

public:
 static void WriteAllText(System::String ^ path, System::String ^ contents);

public static void WriteAllText (string path, string? contents);

static member WriteAllText : string * string -> unit

Public Shared Sub WriteAllText (path As String, contents As String)

Parâmetros

path

String

O arquivo no qual gravar.

contents

String

A cadeia de caracteres a ser gravada no arquivo.

Exceções

ArgumentException

Versões do .NET Framework e do .NET Core anteriores à 2.1: path é uma cadeia de caracteres de comprimento zero, contém apenas espaço em branco ou contém um ou mais caracteres inválidos. Você pode consultar caracteres inválidos usando o método GetInvalidPathChars().

ArgumentNullException

path é null.

PathTooLongException

O caminho especificado, o nome do arquivo ou ambos excedem o comprimento máximo definido pelo sistema.

DirectoryNotFoundException

O caminho especificado é inválido (por exemplo, ele está em uma unidade não mapeada).

IOException

Ocorreu um erro de E/S ao abrir o arquivo.

UnauthorizedAccessException

path especificado um arquivo que é somente leitura.

-ou-

path especificado um arquivo oculto.

-ou-

Não há suporte para essa operação na plataforma atual.

-ou-

path especificado um diretório.

-ou-

O chamador não tem a permissão necessária.

NotSupportedException

path está em um formato inválido.

SecurityException

O chamador não tem a permissão necessária.

Exemplos

O exemplo de código a seguir demonstra o uso do método WriteAllText para gravar texto em um arquivo. Neste exemplo, um arquivo será criado, se ele ainda não existir, e o texto será adicionado a ele.

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

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

        // This text is added only once to the file.
        if (!File.Exists(path))
        {
            // Create a file to write to.
            string createText = "Hello and Welcome" + Environment.NewLine;
            File.WriteAllText(path, createText);
        }

        // This text is always added, making the file longer over time
        // if it is not deleted.
        string appendText = "This is extra text" + Environment.NewLine;
        File.AppendAllText(path, appendText);

        // Open the file to read from.
        string readText = File.ReadAllText(path);
        Console.WriteLine(readText);
    }
}

open System
open System.IO

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

// This text is added only once to the file.
if File.Exists path |> not then
    // Create a file to write to.
    let createText =
        "Hello and Welcome" + Environment.NewLine

    File.WriteAllText(path, createText)

// This text is always added, making the file longer over time
// if it is not deleted.
let appendText =
    "This is extra text" + Environment.NewLine

File.AppendAllText(path, appendText)

// Open the file to read from.
let readText = File.ReadAllText path
printfn $"{readText}"

Imports System.IO
Imports System.Text

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

        ' This text is added only once to the file.
        If File.Exists(path) = False Then

            ' Create a file to write to.
            Dim createText As String = "Hello and Welcome" + Environment.NewLine
            File.WriteAllText(path, createText)
        End If

        ' This text is always added, making the file longer over time
        ' if it is not deleted.
        Dim appendText As String = "This is extra text" + Environment.NewLine
        File.AppendAllText(path, appendText)

        ' Open the file to read from.
        Dim readText As String = File.ReadAllText(path)
        Console.WriteLine(readText)
    End Sub
End Class

Comentários

Esse método usa a codificação UTF-8 sem uma marca de Byte-Order (BOM), portanto, usar o método GetPreamble retornará uma matriz de bytes vazia. Se for necessário incluir um identificador UTF-8, como uma marca de ordem de bytes, no início de um arquivo, use a sobrecarga do método WriteAllText(String, String, Encoding) com UTF8 codificação.

Considerando uma cadeia de caracteres e um caminho de arquivo, esse método abre o arquivo especificado, grava a cadeia de caracteres no arquivo e fecha o arquivo.

WriteAllText(String, String, Encoding)

Origem:

File.cs

Cria um novo arquivo, grava a cadeia de caracteres especificada no arquivo usando a codificação especificada e fecha o arquivo. Se o arquivo de destino já existir, ele será truncado e substituído.

public:
 static void WriteAllText(System::String ^ path, System::String ^ contents, System::Text::Encoding ^ encoding);

public static void WriteAllText (string path, string? contents, System.Text.Encoding encoding);

static member WriteAllText : string * string * System.Text.Encoding -> unit

Public Shared Sub WriteAllText (path As String, contents As String, encoding As Encoding)

Parâmetros

path

String

O arquivo no qual gravar.

contents

String

A cadeia de caracteres a ser gravada no arquivo.

encoding

Encoding

A codificação a ser aplicada à cadeia de caracteres.

Exceções

ArgumentException

Versões do .NET Framework e do .NET Core anteriores à 2.1: path é uma cadeia de caracteres de comprimento zero, contém apenas espaço em branco ou contém um ou mais caracteres inválidos. Você pode consultar caracteres inválidos usando o método GetInvalidPathChars().

ArgumentNullException

path é null.

PathTooLongException

O caminho especificado, o nome do arquivo ou ambos excedem o comprimento máximo definido pelo sistema.

DirectoryNotFoundException

O caminho especificado é inválido (por exemplo, ele está em uma unidade não mapeada).

IOException

Ocorreu um erro de E/S ao abrir o arquivo.

UnauthorizedAccessException

path especificado um arquivo que é somente leitura.

-ou-

path especificado um arquivo oculto.

-ou-

Não há suporte para essa operação na plataforma atual.

-ou-

path especificado um diretório.

-ou-

O chamador não tem a permissão necessária.

NotSupportedException

path está em um formato inválido.

SecurityException

O chamador não tem a permissão necessária.

Exemplos

O exemplo de código a seguir demonstra o uso do método WriteAllText para gravar texto em um arquivo. Neste exemplo, um arquivo será criado, se ele ainda não existir, e o texto será adicionado a ele.

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

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

        // This text is added only once to the file.
        if (!File.Exists(path))
        {
            // Create a file to write to.
            string createText = "Hello and Welcome" + Environment.NewLine;
            File.WriteAllText(path, createText, Encoding.UTF8);
        }

        // This text is always added, making the file longer over time
        // if it is not deleted.
        string appendText = "This is extra text" + Environment.NewLine;
        File.AppendAllText(path, appendText, Encoding.UTF8);

        // Open the file to read from.
        string readText = File.ReadAllText(path);
        Console.WriteLine(readText);
    }
}

open System
open System.IO
open System.Text

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

// This text is added only once to the file.
if File.Exists path |> not then
    // Create a file to write to.
    let createText =
        "Hello and Welcome" + Environment.NewLine

    File.WriteAllText(path, createText, Encoding.UTF8)

// This text is always added, making the file longer over time
// if it is not deleted.
let appendText =
    "This is extra text" + Environment.NewLine

File.AppendAllText(path, appendText, Encoding.UTF8)

// Open the file to read from.
let readText = File.ReadAllText path
printfn $"{readText}"

Imports System.IO
Imports System.Text

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

        ' This text is added only once to the file.
        If File.Exists(path) = False Then

            ' Create a file to write to.
            Dim createText As String = "Hello and Welcome" + Environment.NewLine
            File.WriteAllText(path, createText, Encoding.UTF8)
        End If

        ' This text is always added, making the file longer over time
        ' if it is not deleted.
        Dim appendText As String = "This is extra text" + Environment.NewLine
        File.AppendAllText(path, appendText, Encoding.UTF8)

        ' Open the file to read from.
        Dim readText As String = File.ReadAllText(path)
        Console.WriteLine(readText)
    End Sub
End Class

Comentários

Considerando uma cadeia de caracteres e um caminho de arquivo, esse método abre o arquivo especificado, grava a cadeia de caracteres no arquivo usando a codificação especificada e fecha o arquivo. O identificador de arquivo tem a garantia de ser fechado por esse método, mesmo que exceções sejam geradas.