File.WriteAllText Метод

Определение

Создает новый файл, записывает в него содержимое и затем закрывает файл.Creates a new file, write the contents to the file, and then closes the file. Если целевой файл уже существует, он будет переопределен.If the target file already exists, it is overwritten.

Перегрузки

WriteAllText(String, String)

Создает новый файл, записывает в него указанную строку и затем закрывает файл.Creates a new file, writes the specified string to the file, and then closes the file. Если целевой файл уже существует, он будет переопределен.If the target file already exists, it is overwritten.

WriteAllText(String, String, Encoding)

Создает новый файл, записывает указанную строку в этот файл, используя заданную кодировку, и затем закрывает файл.Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. Если целевой файл уже существует, он будет переопределен.If the target file already exists, it is overwritten.

WriteAllText(String, String)

Создает новый файл, записывает в него указанную строку и затем закрывает файл.Creates a new file, writes the specified string to the file, and then closes the file. Если целевой файл уже существует, он будет переопределен.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);
static member WriteAllText : string * string -> unit
Public Shared Sub WriteAllText (path As String, contents As String)

Параметры

path
String

Файл, в который осуществляется запись.The file to write to.

contents
String

Строка, которую нужно записать в файл.The string to write to the file.

Исключения

path представляет собой строку нулевой длины, содержащую только пробелы или один или несколько недопустимых символов, заданных методом InvalidPathChars.path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.

pathnull.path is null.

Указанный путь, имя файла или оба значения превышают максимальную длину, заданную в системе.The specified path, file name, or both exceed the system-defined maximum length.

Указан недопустимый путь (например, он ведет на несопоставленный диск).The specified path is invalid (for example, it is on an unmapped drive).

При открытии файла произошла ошибка ввода-вывода.An I/O error occurred while opening the file.

Параметр path указывает файл, доступный только для чтения.path specified a file that is read-only.

- или --or- path указывает файл, который скрыт.path specified a file that is hidden.

- или --or- Эта операция не поддерживается на текущей платформе.This operation is not supported on the current platform.

- или --or- Параметрpath определяет каталог.path specified a directory.

- или --or- У вызывающего объекта отсутствует необходимое разрешение.The caller does not have the required permission.

Параметр path задан в недопустимом формате.path is in an invalid format.

У вызывающего объекта отсутствует необходимое разрешение.The caller does not have the required permission.

Примеры

В следующем примере кода показано использование метода WriteAllText для записи текста в файл.The following code example demonstrates the use of the WriteAllText method to write text to a file. В этом примере создается файл, если он еще не существует, и в него добавляется текст.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

Комментарии

Этот метод использует кодировку UTF-8 без метки порядка байтов (BOM), поэтому использование метода GetPreamble вернет пустой массив байтов.This method uses UTF-8 encoding without a Byte-Order Mark (BOM), so using the GetPreamble method will return an empty byte array. Если необходимо включить в начало файла идентификатор UTF-8, например метку порядка байтов, используйте перегрузку метода WriteAllText(String, String, Encoding) с UTF8 кодировкой.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.

При наличии строки и пути к файлу этот метод открывает указанный файл, записывает строку в файл, а затем закрывает файл.Given a string and a file path, this method opens the specified file, writes the string to the file, and then closes the file.

Безопасность

FileIOPermission
для доступа к записи в файл или каталог.for access to write to a file or directory. Связанное перечисление: WriteAssociated enumeration: Write

WriteAllText(String, String, Encoding)

Создает новый файл, записывает указанную строку в этот файл, используя заданную кодировку, и затем закрывает файл.Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. Если целевой файл уже существует, он будет переопределен.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);
static member WriteAllText : string * string * System.Text.Encoding -> unit

Параметры

path
String

Файл, в который осуществляется запись.The file to write to.

contents
String

Строка, которую нужно записать в файл.The string to write to the file.

encoding
Encoding

Кодировка, которую необходимо применить к строке.The encoding to apply to the string.

Исключения

path представляет собой строку нулевой длины, содержащую только пробелы или один или несколько недопустимых символов, заданных методом InvalidPathChars.path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.

pathnull.path is null.

Указанный путь, имя файла или оба значения превышают максимальную длину, заданную в системе.The specified path, file name, or both exceed the system-defined maximum length.

Указан недопустимый путь (например, он ведет на несопоставленный диск).The specified path is invalid (for example, it is on an unmapped drive).

При открытии файла произошла ошибка ввода-вывода.An I/O error occurred while opening the file.

Параметр path указывает файл, доступный только для чтения.path specified a file that is read-only.

- или --or- path указывает файл, который скрыт.path specified a file that is hidden.

- или --or- Эта операция не поддерживается на текущей платформе.This operation is not supported on the current platform.

- или --or- Параметрpath определяет каталог.path specified a directory.

- или --or- У вызывающего объекта отсутствует необходимое разрешение.The caller does not have the required permission.

Параметр path задан в недопустимом формате.path is in an invalid format.

У вызывающего объекта отсутствует необходимое разрешение.The caller does not have the required permission.

Примеры

В следующем примере кода показано использование метода WriteAllText для записи текста в файл.The following code example demonstrates the use of the WriteAllText method to write text to a file. В этом примере создается файл, если он еще не существует, и в него добавляется текст.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

Комментарии

При наличии строки и пути к файлу этот метод открывает указанный файл, записывает строку в файл, используя указанную кодировку, а затем закрывает файл.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. Этот метод гарантированно закрывает этот файл, даже если возникают исключения.The file handle is guaranteed to be closed by this method, even if exceptions are raised.

Безопасность

FileIOPermission
для доступа к записи в файл или каталог.for access to write to a file or directory. Связанное перечисление: WriteAssociated enumeration: Write

Применяется к