File.ReadAllText Метод

Определение

Пространство имен:

System.IO

Сборки:

netstandard.dll, System.Runtime.dll

Открывает текстовый файл, считывает весь текст в файле в строку, а затем закрывает файл.

Перегрузки

Имя	Описание
ReadAllText(String)	Открывает текстовый файл, считывает весь текст в файле, а затем закрывает файл.
ReadAllText(String, Encoding)	Открывает файл, считывает весь текст в файле с указанным кодировкой, а затем закрывает файл.

ReadAllText(String)

Исходный код:

File.cs

Открывает текстовый файл, считывает весь текст в файле, а затем закрывает файл.

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

Параметры

path

String

Файл, который нужно открыть для чтения.

Возвращаемое значение

String

Строка, содержащая весь текст в файле.

Исключения

ArgumentException

Версии .NET Framework и .NET Core старше 2.1: path представляет собой строку нулевой длины, содержит только пробелы или содержит один или несколько недопустимых символов. Вы можете запросить недопустимые символы с помощью метода GetInvalidPathChars().

ArgumentNullException

path равно null.

PathTooLongException

Указанный путь, имя файла или оба превышают определенную системой максимальную длину.

DirectoryNotFoundException

Указанный путь недопустим (например, он находится на несопоставленном диске).

IOException

При открытии файла произошла ошибка ввода-вывода.

UnauthorizedAccessException

Эта операция не поддерживается на текущей платформе.

–или–

path указан каталог.

–или–

Вызывающий объект не имеет требуемого разрешения.

FileNotFoundException

Файл, указанный в path, не найден.

NotSupportedException

path имеет недопустимый формат.

SecurityException

Вызывающий объект не имеет требуемого разрешения.

Примеры

В следующем примере кода показано использование ReadAllText метода для отображения содержимого файла. В этом примере создается файл, если он еще не существует, и в него добавляется текст.

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, малоконечный UTF-16, big-endian UTF-16, малоконечный UTF-32 и текст UTF-32, если файл начинается с соответствующих меток порядка байтов.

Используйте перегрузку ReadAllText(String, Encoding) метода при чтении файлов, которые могут содержать импортированный текст, так как нераспознанные символы могут быть неправильно прочитаны.

Дескриптор файла гарантированно закрывается этим методом, даже если возникают исключения.

См. также раздел

• Файловый и потоковый ввод-вывод
• чтение текста из файла
• Практическое руководство. Запись текста в файл
• Практическое руководство. Чтение и запись в только что созданный файл данных

ReadAllText(String, Encoding)

Исходный код:

File.cs

Открывает файл, считывает весь текст в файле с указанным кодировкой, а затем закрывает файл.

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

Параметры

path

String

Файл, который нужно открыть для чтения.

encoding

Encoding

Кодировка, примененная к содержимому файла.

Возвращаемое значение

String

Строка, содержащая весь текст в файле.

Исключения

ArgumentException

Версии .NET Framework и .NET Core старше 2.1: path представляет собой строку нулевой длины, содержит только пробелы или содержит один или несколько недопустимых символов. Вы можете запросить недопустимые символы с помощью метода GetInvalidPathChars().

ArgumentNullException

path равно null.

PathTooLongException

Указанный путь, имя файла или оба превышают определенную системой максимальную длину.

DirectoryNotFoundException

Указанный путь недопустим (например, он находится на несопоставленном диске).

IOException

При открытии файла произошла ошибка ввода-вывода.

UnauthorizedAccessException

Эта операция не поддерживается на текущей платформе.

–или–

path указан каталог.

–или–

Вызывающий объект не имеет требуемого разрешения.

FileNotFoundException

Файл, указанный в path, не найден.

NotSupportedException

path имеет недопустимый формат.

SecurityException

Вызывающий объект не имеет требуемого разрешения.

Примеры

В следующем примере кода показано использование ReadAllText метода для отображения содержимого файла. В этом примере создается файл, если он еще не существует, и в него добавляется текст.

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

Комментарии

Этот метод открывает файл, считывает весь текст в файле и возвращает его в виде строки. Затем он закрывает файл.

Этот метод пытается автоматически определить кодировку файла на основе наличия меток порядка байтов. Он автоматически распознает UTF-8, малоконечный UTF-16, big-endian UTF-16, малоконечный UTF-32 и текст UTF-32, если файл начинается с соответствующих меток порядка байтов.

Дескриптор файла гарантированно закрывается этим методом, даже если возникают исключения.

Чтобы использовать параметры кодирования, настроенные для операционной системы, укажите Encoding.Default свойство для encoding параметра.

См. также раздел

• Файловый и потоковый ввод-вывод
• чтение текста из файла
• Практическое руководство. Запись текста в файл
• Практическое руководство. Чтение и запись в только что созданный файл данных