File.WriteAllText 方法

参考

定义

命名空间:: System.IO

程序集:: System.Runtime.dll

程序集:: mscorlib.dll, System.IO.FileSystem.dll

程序集:: System.IO.FileSystem.dll

程序集:: mscorlib.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

创建一个新文件，将内容写入文件，然后关闭该文件。如果目标文件已存在，则会截断并覆盖该文件。

重载

WriteAllText(String, ReadOnlySpan<Char>)	创建一个新文件，将指定的字符串写入文件，然后关闭该文件。如果目标文件已存在，则会截断并覆盖该文件。
WriteAllText(String, String)	创建一个新文件，将指定的字符串写入文件，然后关闭该文件。如果目标文件已存在，则会截断并覆盖该文件。
WriteAllText(String, ReadOnlySpan<Char>, Encoding)	创建一个新文件，使用指定的编码将指定的字符串写入文件，然后关闭该文件。如果目标文件已存在，则会截断并覆盖该文件。
WriteAllText(String, String, Encoding)	创建一个新文件，使用指定的编码将指定的字符串写入文件，然后关闭该文件。如果目标文件已存在，则会截断并覆盖该文件。

WriteAllText(String, ReadOnlySpan<Char>)

创建一个新文件，将指定的字符串写入文件，然后关闭该文件。

如果目标文件已存在，则会截断并覆盖该文件。

public:
 static void WriteAllText(System::String ^ path, ReadOnlySpan<char> contents);

public static void WriteAllText (string path, ReadOnlySpan<char> contents);

static member WriteAllText : string * ReadOnlySpan<char> -> unit

Public Shared Sub WriteAllText (path As String, contents As ReadOnlySpan(Of Char))

参数

path: String

要写入的文件。

contents: ReadOnlySpan<Char>

要写入文件的字符。

例外

ArgumentNullException

path null。

ArgumentException

path 为空。

PathTooLongException

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

DirectoryNotFoundException

指定的路径无效（例如，它位于未映射的驱动器上）。

IOException

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

UnauthorizedAccessException

path 指定了只读文件。

-或-

path 指定了隐藏的文件。

-或-

path 指定了目录。

-或-

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

调用方没有所需的权限。

NotSupportedException

path 格式无效。

注解

此方法使用不带 Byte-Order Mark（BOM）的 UTF-8 编码，因此使用 GetPreamble() 方法将返回空字节数组。如果需要在文件的开头包含 UTF-8 标识符（如字节顺序标记），请使用 WriteAllText(String, ReadOnlySpan<Char>, Encoding) 方法。

适用于

WriteAllText(String, String)

Source:: File.cs

Source:: File.cs

Source:: File.cs

创建一个新文件，将指定的字符串写入文件，然后关闭该文件。如果目标文件已存在，则会截断并覆盖该文件。

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)

参数

path: String

要写入的文件。

contents: String

要写入文件的字符串。

例外

ArgumentException

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

ArgumentNullException

path null。

PathTooLongException

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

DirectoryNotFoundException

指定的路径无效（例如，它位于未映射的驱动器上）。

IOException

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

UnauthorizedAccessException

path 指定了只读文件。

-或-

path 指定了隐藏的文件。

-或-

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

-或-

path 指定了目录。

-或-

调用方没有所需的权限。

NotSupportedException

path 格式无效。

SecurityException

调用方没有所需的权限。

示例

下面的代码示例演示如何使用 WriteAllText 方法将文本写入文件。在此示例中，创建了一个文件（如果该文件尚不存在），并将文本添加到其中。

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

注解

此方法使用不带 Byte-Order Mark（BOM）的 UTF-8 编码，因此使用 GetPreamble 方法将返回空字节数组。如果需要在文件的开头包含 UTF-8 标识符（如字节顺序标记），请使用具有 UTF8 编码的 WriteAllText(String, String, Encoding) 方法重载。

给定字符串和文件路径后，此方法将打开指定的文件，将字符串写入文件，然后关闭该文件。

适用于

WriteAllText(String, ReadOnlySpan<Char>, Encoding)

创建一个新文件，使用指定的编码将指定的字符串写入文件，然后关闭该文件。

如果目标文件已存在，则会截断并覆盖该文件。

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

public static void WriteAllText (string path, ReadOnlySpan<char> contents, System.Text.Encoding encoding);

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

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

参数

path: String

要写入的文件。

contents: ReadOnlySpan<Char>

要写入文件的字符。

encoding: Encoding

要应用于字符串的编码。

例外

ArgumentNullException

path 或 encodingnull。

ArgumentException

path 为空。

PathTooLongException

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

DirectoryNotFoundException

指定的路径无效（例如，它位于未映射的驱动器上）。

IOException

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

UnauthorizedAccessException

path 指定了只读文件。

-或-

path 指定了隐藏的文件。

-或-

path 指定了目录。

-或-

调用方没有所需的权限。

-或-

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

NotSupportedException

path 格式无效。

适用于

WriteAllText(String, String, Encoding)

Source:: File.cs

Source:: File.cs

Source:: File.cs

创建一个新文件，使用指定的编码将指定的字符串写入文件，然后关闭该文件。如果目标文件已存在，则会截断并覆盖该文件。

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)

参数

path: String

要写入的文件。

contents: String

要写入文件的字符串。

encoding: Encoding

要应用于字符串的编码。

例外

ArgumentException

ArgumentNullException

path null。

PathTooLongException

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

DirectoryNotFoundException

指定的路径无效（例如，它位于未映射的驱动器上）。

IOException

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

UnauthorizedAccessException

path 指定了只读文件。

-或-

path 指定了隐藏的文件。

-或-

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

-或-

path 指定了目录。

-或-

调用方没有所需的权限。

NotSupportedException

path 格式无效。

SecurityException

调用方没有所需的权限。

示例

下面的代码示例演示如何使用 WriteAllText 方法将文本写入文件。在此示例中，创建了一个文件（如果该文件尚不存在），并将文本添加到其中。

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

注解

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

适用于

通过

File.WriteAllText 方法

定义

重载

WriteAllText(String, ReadOnlySpan<Char>)

参数

例外

注解

适用于

WriteAllText(String, String)

参数

例外

示例

注解

适用于

WriteAllText(String, ReadOnlySpan<Char>, Encoding)

参数

例外

适用于

WriteAllText(String, String, Encoding)

参数

例外

示例

注解

适用于

其他资源