File.AppendAllText 方法

定义

命名空间:

System.IO

程序集:

System.Runtime.dll

将指定的字符串追加到该文件，如果该文件尚不存在，则创建该文件。

重载

AppendAllText(String, String)	打开一个文件，将指定的字符串追加到该文件，然后关闭该文件。 如果文件不存在，此方法将创建一个文件，将指定的字符串写入该文件，然后关闭该文件。
AppendAllText(String, String, Encoding)	使用指定的编码将指定的字符串追加到文件，如果该文件尚不存在，则创建该文件。

AppendAllText(String, String)

Source:

File.cs

打开一个文件，将指定的字符串追加到该文件，然后关闭该文件。 如果文件不存在，此方法将创建一个文件，将指定的字符串写入该文件，然后关闭该文件。

C#

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

参数

path

String

要向其追加指定字符串的文件。

contents

String

要追加到文件的字符串。

例外

ArgumentException

低于 2.1 的 .NET Framework 和 .NET Core 版本：path 为零长度的字符串，仅包含空格，或包含一个或多个无效字符。 可以使用 GetInvalidPathChars() 方法查询无效字符。

ArgumentNullException

path null。

PathTooLongException

指定的路径、文件名或两者都超过了系统定义的最大长度。

DirectoryNotFoundException

指定的路径无效（例如，目录不存在或位于未映射的驱动器上）。

IOException

打开文件时出现 I/O 错误。

UnauthorizedAccessException

path 指定了只读文件。

-或-

当前平台上不支持此操作。

-或-

path 指定了目录。

-或-

调用方没有所需的权限。

NotSupportedException

path 格式无效。

SecurityException

调用方没有所需的权限。

示例

下面的代码示例演示如何使用 AppendAllText 方法向文件末尾添加额外的文本。 在此示例中，如果文件尚不存在，则会创建一个文件，并将文本添加到其中。 但是，驱动器 C 上名为 temp 的目录必须存在，才能使示例成功完成。

C#

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

注解

给定字符串和文件路径后，此方法将打开指定的文件，将字符串追加到文件末尾，然后关闭该文件。 即使引发异常，文件句柄也保证由此方法关闭。

如果文件不存在，该方法将创建该文件，但不会创建新目录。 因此，path 参数的值必须包含现有目录。

AppendAllText(String, String, Encoding)

Source:

File.cs

使用指定的编码将指定的字符串追加到文件，如果该文件尚不存在，则创建该文件。

C#

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

参数

path

String

要向其追加指定字符串的文件。

contents

String

要追加到文件的字符串。

encoding

Encoding

要使用的字符编码。

例外

ArgumentException

低于 2.1 的 .NET Framework 和 .NET Core 版本：path 为零长度的字符串，仅包含空格，或包含一个或多个无效字符。 可以使用 GetInvalidPathChars() 方法查询无效字符。

ArgumentNullException

path null。

PathTooLongException

指定的路径、文件名或两者都超过了系统定义的最大长度。

DirectoryNotFoundException

指定的路径无效（例如，目录不存在或位于未映射的驱动器上）。

IOException

打开文件时出现 I/O 错误。

UnauthorizedAccessException

path 指定了只读文件。

-或-

当前平台上不支持此操作。

-或-

path 指定了目录。

-或-

调用方没有所需的权限。

NotSupportedException

path 格式无效。

SecurityException

调用方没有所需的权限。

示例

下面的代码示例演示如何使用 AppendAllText 方法向文件末尾添加额外的文本。 在此示例中，如果文件尚不存在，则会创建一个文件，并将文本添加到其中。 但是，驱动器 C 上名为 temp 的目录必须存在，才能使示例成功完成。

C#

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

注解

给定字符串和文件路径后，此方法将打开指定的文件，使用指定的编码将字符串追加到文件的末尾，然后关闭该文件。 即使引发异常，文件句柄也保证由此方法关闭。

如果文件不存在，该方法将创建该文件，但不会创建新目录。 因此，path 参数的值必须包含现有目录。