File.WriteAllText 方法
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
建立新的檔案、將內容寫入檔案,然後關閉檔案。 如果目標檔案已經存在,則會遭到截斷並覆寫。
WriteAllText(String, ReadOnlySpan<Char>) |
建立新的檔案、將指定的字串寫入檔案,然後關閉檔案。 如果目標檔案已經存在,則會遭到截斷並覆寫。 |
WriteAllText(String, String) |
建立新的檔案、將指定的字串寫入檔案,然後關閉檔案。 如果目標檔案已經存在,則會遭到截斷並覆寫。 |
WriteAllText(String, ReadOnlySpan<Char>, Encoding) |
建立新的檔案、使用指定的編碼將指定的字串寫入檔案,然後關閉檔案。 如果目標檔案已經存在,則會遭到截斷並覆寫。 |
WriteAllText(String, String, Encoding) |
建立新的檔案、使用指定的編碼將指定的字串寫入檔案,然後關閉檔案。 如果目標檔案已經存在,則會遭到截斷並覆寫。 |
建立新的檔案、將指定的字串寫入檔案,然後關閉檔案。
如果目標檔案已經存在,則會遭到截斷並覆寫。
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>
要寫入檔案的字元。
例外狀況
path
null
。
path
是空的。
指定的路徑、檔名或兩者都超過系統定義的最大長度。
指定的路徑無效(例如,它位於未對應的磁碟驅動器上)。
開啟檔案時發生 I/O 錯誤。
path
指定唯讀的檔案。
-或-
path
指定隱藏的檔案。
-或-
path
指定目錄。
-或-
目前平臺不支援此作業。
呼叫端沒有必要的許可權。
path
格式無效。
備註
這個方法會使用UTF-8編碼,而不使用 Byte-Order Mark (BOM),因此使用 GetPreamble() 方法會傳回空的位元組陣列。 如果需要在檔案開頭包含UTF-8標識元,例如位元組順序標記,請使用 WriteAllText(String, ReadOnlySpan<Char>, Encoding) 方法。
適用於
.NET 9
產品 | 版本 |
---|---|
.NET | 9 |
- 來源:
- File.cs
- 來源:
- File.cs
- 來源:
- 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
要寫入檔案的字串。
例外狀況
比 2.1 舊的 .NET Framework 和 .NET Core 版本:path
是長度為零的字串、只包含空格符,或包含一或多個無效字元。 您可以使用 GetInvalidPathChars() 方法來查詢無效的字元。
path
null
。
指定的路徑、檔名或兩者都超過系統定義的最大長度。
指定的路徑無效(例如,它位於未對應的磁碟驅動器上)。
開啟檔案時發生 I/O 錯誤。
path
指定唯讀的檔案。
-或-
path
指定隱藏的檔案。
-或-
目前平臺不支援此作業。
-或-
path
指定目錄。
-或-
呼叫端沒有必要的許可權。
path
格式無效。
呼叫端沒有必要的許可權。
範例
下列程式代碼範例示範如何使用 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
備註
這個方法會使用UTF-8編碼,而不使用 Byte-Order Mark (BOM),因此使用 GetPreamble 方法會傳回空的位元組陣列。 如果需要在檔案開頭包含UTF-8標識元,例如位元組順序標記,請使用具有 UTF8 編碼的 WriteAllText(String, String, Encoding) 方法多載。
指定字串和檔案路徑時,這個方法會開啟指定的檔案、將字串寫入檔案,然後關閉檔案。
適用於
.NET 9 及其他版本
產品 | 版本 |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.3, 1.4, 1.6, 2.0, 2.1 |
UWP | 10.0 |
建立新的檔案、使用指定的編碼將指定的字串寫入檔案,然後關閉檔案。
如果目標檔案已經存在,則會遭到截斷並覆寫。
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
要套用至字串的編碼方式。
例外狀況
path
或 encoding
null
。
path
是空的。
指定的路徑、檔名或兩者都超過系統定義的最大長度。
指定的路徑無效(例如,它位於未對應的磁碟驅動器上)。
開啟檔案時發生 I/O 錯誤。
path
指定唯讀的檔案。
-或-
path
指定隱藏的檔案。
-或-
path
指定目錄。
-或-
呼叫端沒有必要的許可權。
-或-
目前平臺不支援此作業。
path
格式無效。
適用於
.NET 9
產品 | 版本 |
---|---|
.NET | 9 |
- 來源:
- File.cs
- 來源:
- File.cs
- 來源:
- 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
要套用至字串的編碼方式。
例外狀況
比 2.1 舊的 .NET Framework 和 .NET Core 版本:path
是長度為零的字串、只包含空格符,或包含一或多個無效字元。 您可以使用 GetInvalidPathChars() 方法來查詢無效的字元。
path
null
。
指定的路徑、檔名或兩者都超過系統定義的最大長度。
指定的路徑無效(例如,它位於未對應的磁碟驅動器上)。
開啟檔案時發生 I/O 錯誤。
path
指定唯讀的檔案。
-或-
path
指定隱藏的檔案。
-或-
目前平臺不支援此作業。
-或-
path
指定目錄。
-或-
呼叫端沒有必要的許可權。
path
格式無效。
呼叫端沒有必要的許可權。
範例
下列程式代碼範例示範如何使用 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
備註
指定字串和檔案路徑時,這個方法會開啟指定的檔案、使用指定的編碼將字串寫入檔案,然後關閉檔案。 即使引發例外狀況,這個方法仍保證會關閉檔句柄。
適用於
.NET 9 及其他版本
產品 | 版本 |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9 |
.NET Framework | 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 1.3, 1.4, 1.6, 2.0, 2.1 |
UWP | 10.0 |