File.WriteAllText Método

Definição

Cria um novo arquivo, grava os conteúdos nele e o fecha.Creates a new file, write the contents to the file, and then closes the file. Se o arquivo de destino já existir, ele será substituído.If the target file already exists, it is overwritten.

Sobrecargas

WriteAllText(String, String)

Cria um novo arquivo, grava a cadeia de caracteres especificada no arquivo e fecha o arquivo.Creates a new file, writes the specified string to the file, and then closes the file. Se o arquivo de destino já existir, ele será substituído.If the target file already exists, it is overwritten.

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.Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. Se o arquivo de destino já existir, ele será substituído.If the target file already exists, it is overwritten.

WriteAllText(String, String)

Cria um novo arquivo, grava a cadeia de caracteres especificada no arquivo e fecha o arquivo.Creates a new file, writes the specified string to the file, and then closes the file. Se o arquivo de destino já existir, ele será substituído.If the target file already exists, it is overwritten.

public:
 static void WriteAllText(System::String ^ path, System::String ^ contents);
public static void WriteAllText (string path, 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 para gravação.The file to write to.

contents
String

A cadeia de caracteres a ser gravada no arquivo.The string to write to the file.

Exceções

path é uma cadeia de comprimento zero, contém somente espaços em branco ou um ou mais caracteres inválidos, conforme definido por InvalidPathChars.path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.

path é null.path is null.

O caminho especificado, o nome de arquivo, ou ambos excedem o tamanho máximo definido pelo sistema.The specified path, file name, or both exceed the system-defined maximum length.

O caminho especificado é inválido (por exemplo, ele está em uma unidade não mapeada).The specified path is invalid (for example, it is on an unmapped drive).

Um erro de E/S ocorreu ao abrir o arquivo.An I/O error occurred while opening the file.

path especificou um arquivo somente leitura.path specified a file that is read-only.

- ou --or- path especificou um arquivo que está oculto.path specified a file that is hidden.

- ou --or- Não há suporte para essa operação na plataforma atual.This operation is not supported on the current platform.

- ou --or- path especificou um diretório.path specified a directory.

- ou --or- O chamador não tem a permissão necessária.The caller does not have the required permission.

path está em um formato inválido.path is in an invalid format.

O chamador não tem a permissão necessária.The caller does not have the required permission.

Exemplos

O exemplo de código a seguir demonstra o uso do WriteAllText método para gravar texto em um arquivo.The following code example demonstrates the use of the WriteAllText method to write text to a file. Neste exemplo, um arquivo é criado, se ele ainda não existir, e o texto é adicionado a ele.In this example a file is created, if it doesn't already exist, and text is added to it.

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);
    }
}
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 GetPreamble método retornará uma matriz de bytes vazia.This method uses UTF-8 encoding without a Byte-Order Mark (BOM), so using the GetPreamble method will return an empty byte array. Se for necessário incluir um identificador UTF-8, como uma marca de ordem de byte, no início de um arquivo, use a sobrecarga do WriteAllText(String, String, Encoding) método com UTF8 codificação.If it is necessary to include a UTF-8 identifier, such as a byte order mark, at the beginning of a file, use the WriteAllText(String, String, Encoding) method overload with UTF8 encoding.

Dada 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.Given a string and a file path, this method opens the specified file, writes the string to the file, and then closes the file.

Aplica-se a

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.Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. Se o arquivo de destino já existir, ele será substituído.If the target file already exists, it is overwritten.

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);
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 para gravação.The file to write to.

contents
String

A cadeia de caracteres a ser gravada no arquivo.The string to write to the file.

encoding
Encoding

A codificação a ser aplicada à cadeia de caracteres.The encoding to apply to the string.

Exceções

path é uma cadeia de comprimento zero, contém somente espaços em branco ou um ou mais caracteres inválidos, conforme definido por InvalidPathChars.path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.

path é null.path is null.

O caminho especificado, o nome de arquivo, ou ambos excedem o tamanho máximo definido pelo sistema.The specified path, file name, or both exceed the system-defined maximum length.

O caminho especificado é inválido (por exemplo, ele está em uma unidade não mapeada).The specified path is invalid (for example, it is on an unmapped drive).

Um erro de E/S ocorreu ao abrir o arquivo.An I/O error occurred while opening the file.

path especificou um arquivo somente leitura.path specified a file that is read-only.

- ou --or- path especificou um arquivo que está oculto.path specified a file that is hidden.

- ou --or- Não há suporte para essa operação na plataforma atual.This operation is not supported on the current platform.

- ou --or- path especificou um diretório.path specified a directory.

- ou --or- O chamador não tem a permissão necessária.The caller does not have the required permission.

path está em um formato inválido.path is in an invalid format.

O chamador não tem a permissão necessária.The caller does not have the required permission.

Exemplos

O exemplo de código a seguir demonstra o uso do WriteAllText método para gravar texto em um arquivo.The following code example demonstrates the use of the WriteAllText method to write text to a file. Neste exemplo, um arquivo é criado, se ele ainda não existir, e o texto é adicionado a ele.In this example a file is created, if it doesn't already exist, and text is added to it.

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);
    }
}
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

Dada 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, em seguida, fecha o arquivo.Given a string and a file path, this method opens the specified file, writes the string to the file using the specified encoding, and then closes the file. É garantido que o identificador do arquivo seja fechado por esse método, mesmo que as exceções sejam geradas.The file handle is guaranteed to be closed by this method, even if exceptions are raised.

Aplica-se a