My.Computer.FileSystem.WriteAllText (Método)

Artículo
08/23/2008

Actualización: noviembre 2007

Escribe texto en un archivo.

' 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 _
)

Parámetros

file
String. Archivo en el que se va a escribir. Obligatorio.
text
String. Texto que se va a escribir en el archivo. Obligatorio.
append
Boolean. Si el texto se va a anexar o sobrescribir en el texto existente. El valor predeterminado es False. Obligatorio.
encoding
Encoding. Qué codificación se usa al escribir en un archivo. Obligatorio. El valor predeterminado es UTF-8.

Excepciones

Las condiciones siguientes pueden producir una excepción:

La ruta de acceso no es válida por una de las razones siguientes: es una cadena de longitud cero; sólo contiene un espacio en blanco; contiene caracteres no válidos; termina con una barra diagonal; o es una ruta de acceso de dispositivo (empieza por \\.\) (ArgumentException).
La ruta de acceso no es válida porque es Nothing (ArgumentNullException).
file señala a una ruta de acceso que no existe (FileNotFoundException o DirectoryNotFoundException).
El archivo está en uso por otro proceso o hay un error de E/S (IOException).
La ruta de acceso supera la longitud máxima definida por el sistema (PathTooLongException).
Un nombre de archivo o de directorio de la ruta de acceso contiene un signo de dos puntos (:) o tiene un formato no válido (NotSupportedException).
El usuario no tiene los permisos necesarios para ver la ruta de acceso (SecurityException).

Si ejecuta el código en un contexto de confianza parcial, podría desencadenarse una excepción por falta de permisos. Para obtener más información, vea Conceptos básicos sobre la seguridad de acceso a código.

Comentarios

Cuando no se especifica ninguna codificación, se utiliza UTF-8. La marca de orden de bytes (BOM) para la codificación se escribe en el archivo, a menos que se especifique Encoding.Default, que utiliza la actual página de códigos ANSI del sistema. Si la codificación especificada no coincide con la codificación existente del archivo, se omite la codificación especificada.

Si la ruta de acceso especificada, excepto el nombre de archivo, no es válida, se producirá una excepción DirectoryNotFoundException. Si la ruta de acceso es válida pero el archivo no existe, se crea el archivo.

Si el parámetro append es True, el método anexa el texto al archivo; de lo contrario, se sobrescribe el texto existente en el archivo.

Nota:
El método WriteAllText abre un archivo, escribe en él y, a continuación, lo cierra. El código que usa el método WriteAllText es más sencillo que el código que usa un objeto StreamWriter. Sin embargo, si se están agregando cadenas a un archivo mediante un bucle, un objeto StreamWriter puede ofrecer mejor rendimiento porque solamente tiene que abrir y cerrar el archivo una vez. Para obtener más información, vea My.Computer.FileSystem.OpenTextFileWriter (Método).

El método WriteAllText abre un archivo, escribe en él y, a continuación, lo cierra. El código que usa el método WriteAllText es más sencillo que el código que usa un objeto StreamWriter. Sin embargo, si se están agregando cadenas a un archivo mediante un bucle, un objeto StreamWriter puede ofrecer mejor rendimiento porque solamente tiene que abrir y cerrar el archivo una vez. Para obtener más información, vea My.Computer.FileSystem.OpenTextFileWriter (Método).

Tareas

La tabla siguiente muestra ejemplos de tareas que implican al método My.Computer.FileSystem.WriteAllText.

Para	Vea
Escribir texto en un archivo	Cómo: Escribir texto en archivos en Visual Basic
Anexar texto a un archivo	Cómo: Anexar a archivos de texto en Visual Basic

Ejemplo

Este ejemplo escribe la línea "This is new text to be added." en el archivo Test.txt y sobrescribe el texto existente en el archivo.

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

Este ejemplo escribe los nombres de los archivos de la carpeta Documents and Settings en FileList.txt e inserta un retorno de carro entre cada uno para mejor legibilidad.

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

Requisitos

Espacio de nombres:Microsoft.VisualBasic.MyServices

Clase:FileSystemProxy (proporciona acceso a FileSystem)

Ensamblado: biblioteca en tiempo de ejecución de Visual Basic (en Microsoft.VisualBasic.dll)

Disponibilidad por tipo de proyecto

Tipo de proyecto	Disponible
Aplicación para Windows	Sí
Biblioteca de clases	Sí
Aplicación de consola	Sí
Biblioteca de controles de Windows	Sí
Biblioteca de controles Web	Sí
Servicio de Windows	Sí
Sitio Web	Sí