File.ReadAllText Método

Definición

Espacio de nombres:

System.IO

Ensamblados:

mscorlib.dll, System.IO.FileSystem.dll

Ensamblado:

System.IO.FileSystem.dll

Ensamblado:

System.Runtime.dll

Ensamblado:

mscorlib.dll

Ensamblado:

netstandard.dll

Abre un archivo de texto, lee todo el texto del archivo en una cadena y, a continuación, cierra el archivo.

Sobrecargas

ReadAllText(String)	Abre un archivo de texto, lee todo el texto del archivo y, a continuación, cierra el archivo.
ReadAllText(String, Encoding)	Abre un archivo, lee todo el texto del archivo con la codificación especificada y, a continuación, cierra el archivo.

ReadAllText(String)

Abre un archivo de texto, lee todo el texto del archivo y, a continuación, cierra el archivo.

public:
 static System::String ^ ReadAllText(System::String ^ path);

public static string ReadAllText (string path);

static member ReadAllText : string -> string

Public Shared Function ReadAllText (path As String) As String

Parámetros

path

String

Archivo que se abre para la lectura.

Devoluciones

String

Cadena que contiene todo el texto del archivo.

Excepciones

ArgumentException

Versiones de .NET Framework y .NET Core anteriores a 2.1: path es una cadena de longitud cero, solo contiene espacios en blanco o contiene uno o varios caracteres no válidos. Puede consultar los caracteres no válidos con el método GetInvalidPathChars().

ArgumentNullException

path es null.

PathTooLongException

La ruta de acceso especificada, el nombre de archivo o ambos superan la longitud máxima definida por el sistema.

DirectoryNotFoundException

La ruta de acceso especificada no es válida (por ejemplo, está en una unidad no asignada).

IOException

Se produjo un error de E/S al abrir el archivo.

UnauthorizedAccessException

path especificó un archivo que es de solo lectura.

o bien Esta operación no es compatible con la plataforma actual.

o bien path especificó un directorio.

o bien El llamador no dispone del permiso requerido.

FileNotFoundException

No se encontró el archivo especificado en path.

NotSupportedException

path está en un formato no válido.

SecurityException

El llamador no dispone del permiso requerido.

Ejemplos

En el ejemplo de código siguiente se muestra el uso del ReadAllText método para mostrar el contenido de un archivo. En este ejemplo se crea un archivo, si aún no existe y se agrega texto a él.

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

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

Comentarios

Este método abre un archivo, lee todo el texto del archivo y lo devuelve como una cadena. A continuación, cierra el archivo.

Este método intenta detectar automáticamente la codificación de un archivo en función de la presencia de marcas de orden de bytes. Se pueden detectar formatos de codificación UTF-8 y UTF-32 (big-endian y little-endian).

Use la sobrecarga del ReadAllText(String, Encoding) método al leer archivos que podrían contener texto importado, ya que es posible que los caracteres no reconocidos no se lean correctamente.

Este método garantiza que este método cierre el identificador de archivo, incluso si se generan excepciones.

Consulte también

• E/S de archivos y secuencias
• Leer texto de un archivo
• Procedimiento para escribir texto en un archivo
• Procedimiento para leer y escribir en un archivo de datos recién creado

ReadAllText(String, Encoding)

Abre un archivo, lee todo el texto del archivo con la codificación especificada y, a continuación, cierra el archivo.

public:
 static System::String ^ ReadAllText(System::String ^ path, System::Text::Encoding ^ encoding);

public static string ReadAllText (string path, System.Text.Encoding encoding);

static member ReadAllText : string * System.Text.Encoding -> string

Public Shared Function ReadAllText (path As String, encoding As Encoding) As String

Parámetros

path

String

Archivo que se abre para la lectura.

encoding

Encoding

Codificación aplicada al contenido del archivo.

Devoluciones

String

Cadena que contiene todo el texto del archivo.

Excepciones

ArgumentException

Versiones de .NET Framework y .NET Core anteriores a 2.1: path es una cadena de longitud cero, solo contiene espacios en blanco o contiene uno o varios caracteres no válidos. Puede consultar los caracteres no válidos con el método GetInvalidPathChars().

ArgumentNullException

path es null.

PathTooLongException

La ruta de acceso especificada, el nombre de archivo o ambos superan la longitud máxima definida por el sistema.

DirectoryNotFoundException

La ruta de acceso especificada no es válida (por ejemplo, está en una unidad no asignada).

IOException

Se produjo un error de E/S al abrir el archivo.

UnauthorizedAccessException

path especificó un archivo que es de solo lectura.

o bien Esta operación no es compatible con la plataforma actual.

o bien path especificó un directorio.

o bien El llamador no dispone del permiso requerido.

FileNotFoundException

No se encontró el archivo especificado en path.

NotSupportedException

path está en un formato no válido.

SecurityException

El llamador no dispone del permiso requerido.

Ejemplos

En el ejemplo de código siguiente se muestra el uso del ReadAllText método para mostrar el contenido de un archivo. En este ejemplo se crea un archivo, si aún no existe y se agrega texto a él.

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

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

Comentarios

Este método abre un archivo, lee todo el texto del archivo y lo devuelve como una cadena. A continuación, cierra el archivo.

Este método intenta detectar automáticamente la codificación de un archivo en función de la presencia de marcas de orden de bytes. Se pueden detectar formatos de codificación UTF-8 y UTF-32 (big-endian y little-endian).

Este método garantiza que este método cierre el identificador de archivo, incluso si se generan excepciones.

Para usar los valores de codificación como configurados para el sistema operativo, especifique la Encoding.Default propiedad para el encoding parámetro .

Consulte también

• E/S de archivos y secuencias
• Leer texto de un archivo
• Procedimiento para escribir texto en un archivo
• Procedimiento para leer y escribir en un archivo de datos recién creado