My.Computer.FileSystem.WriteAllText 方法

2008-08-18

更新：2007 年 11 月

向文件写入文本。

' Usage
My.Computer.FileSystem.WriteAllText(file ,text ,append)
My.Computer.FileSystem.WriteAllText(file ,text ,append ,encoding)
' Declaration
Public Sub WriteAllText( _
   ByVal file As String, _
   ByVal text As String, _
   ByVal append As Boolean _
)
' -or-
Public Sub WriteAllText( _
   ByVal file As String, _
   ByVal text As String, _
   ByVal append As Boolean, _
   ByVal encoding As System.Text.Encoding _
)

参数

file
String。要写入的文件。必需。
text
String。要写入文件的文本。必需。
append
Boolean。是追加文本还是覆盖现有文本。默认值为 False。必需。
encoding
Encoding. 写入文件时使用的编码。必需。默认值为 UTF-8。

异常

以下情况可能会导致异常：

路径由于以下原因之一而无效：它是零长度字符串；它仅包含空格；它包含无效字符、以尾部斜杠结尾或是一个设备路径（以 \\.\ 开头）(ArgumentException)。
路径无效，因为它是 Nothing (ArgumentNullException)。
file 指向的路径不存在（FileNotFoundException 或 DirectoryNotFoundException）。
文件正由另一个进程使用，或者出现 I/O 错误 (IOException)。
路径超过了系统定义的最大长度 (PathTooLongException)。
路径中的文件名或目录名包含冒号 (:)，或格式无效 (NotSupportedException)。
该用户缺少查看该路径所必需的权限 (SecurityException)。

如果在部分信任的上下文中运行，代码可能会由于没有足够的权限而引发异常。有关更多信息，请参见代码访问安全性基础知识。

备注

如果未指定编码方法，将使用 UTF-8。只要不指定 Encoding.Default，就会将编码的字节顺序标记 (BOM) 写入文件，否则将使用系统当前的 ANSI 代码页。如果指定的编码与文件的现有编码不匹配，则会忽略指定的编码。

如果不包括文件名的指定路径无效，将引发 DirectoryNotFoundException 异常。如果路径有效但文件不存在，则会创建文件。

如果 append 参数为 True，则该方法会将文本追加到文件中；否则将会覆盖文件中的现有文本。

说明：
WriteAllText 方法将打开一个文件，向其写入内容，然后将其关闭。使用 WriteAllText 方法的代码比使用 StreamWriter 对象的代码更加简单。但是，如果您使用循环将字符串添加到文件中，则 StreamWriter 对象能够提供更优异的性能，因为您只需打开和关闭该文件一次。有关更多信息，请参见 My.Computer.FileSystem.OpenTextFileWriter 方法。

WriteAllText 方法将打开一个文件，向其写入内容，然后将其关闭。使用 WriteAllText 方法的代码比使用 StreamWriter 对象的代码更加简单。但是，如果您使用循环将字符串添加到文件中，则 StreamWriter 对象能够提供更优异的性能，因为您只需打开和关闭该文件一次。有关更多信息，请参见 My.Computer.FileSystem.OpenTextFileWriter 方法。

任务

下表列出了涉及 My.Computer.FileSystem.WriteAllText 方法的任务的示例。

要执行的操作	请参见
向文件写入文本	如何：在 Visual Basic 中向文件内写入文本
向文件中追加文本	如何：在 Visual Basic 中向文本文件追加内容

示例

此示例将行 "This is new text to be added." 写入文件 Test.txt，它将覆盖文件中的所有现有文本。

My.Computer.FileSystem.WriteAllText("C:\TestFolder1\test.txt", _
"This is new text to be added.", False)

此示例将 Documents and Settings 文件夹中文件的名称写入 FileList.txt，它将在各文件名之间插入回车符，以提高可读性。

For Each foundFile As String In _
My.Computer.FileSystem.GetFiles("C:\Documents and Settings")
    foundFile = foundFile & vbCrLf
    My.Computer.FileSystem.WriteAllText _
    ("C:\Documents and Settings\FileList.txt", foundFile, True)
Next