File.ReadLines Метод

Определение

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

System.IO

Сборка:

System.Runtime.dll

Считывает строки файла.

Перегрузки

ReadLines(String, Encoding)	Чтение строк файла с заданным кодировкой.
ReadLines(String)	Считывает строки файла.

ReadLines(String, Encoding)

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

File.cs

Чтение строк файла с заданным кодировкой.

C#

public static System.Collections.Generic.IEnumerable<string> ReadLines (string path, System.Text.Encoding encoding);

Параметры

path

String

Файл для чтения.

encoding

Encoding

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

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

IEnumerable<String>

Все строки файла или строки, которые являются результатом запроса.

Исключения

ArgumentException

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

ArgumentNullException

path null.

DirectoryNotFoundException

path недопустим (например, он находится на несопоставленном диске).

FileNotFoundException

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

IOException

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

PathTooLongException

path превышает определенную системой максимальную длину.

SecurityException

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

UnauthorizedAccessException

path указывает файл, доступный только для чтения.

-или-

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

-или-

path — это каталог.

-или-

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

Комментарии

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

Методы ReadLines и ReadAllLines отличаются следующим образом: при использовании ReadLinesможно начать перечисление коллекции строк перед возвратом всей коллекции. При использовании ReadAllLinesнеобходимо дождаться возврата всего массива строк, прежде чем получить доступ к массиву. Поэтому при работе с очень большими файлами ReadLines может быть более эффективным.

Для выполнения следующих действий можно использовать метод ReadLines.

• Выполните LINQ to Objects запросы к файлу, чтобы получить отфильтрованный набор строк.

• Напишите возвращаемую коллекцию строк в файл с помощью метода File.WriteAllLines(String, IEnumerable<String>, Encoding) или добавьте их в существующий файл с помощью метода File.AppendAllLines(String, IEnumerable<String>, Encoding).

• Создайте немедленно заполненный экземпляр коллекции, которая принимает коллекцию строк IEnumerable<T> для конструктора, например IList<T> или Queue<T>.

ReadLines(String)

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

File.cs

Считывает строки файла.

C#

public static System.Collections.Generic.IEnumerable<string> ReadLines (string path);

Параметры

path

String

Файл для чтения.

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

IEnumerable<String>

Все строки файла или строки, которые являются результатом запроса.

Исключения

ArgumentException

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

ArgumentNullException

path null.

DirectoryNotFoundException

path недопустим (например, он находится на несопоставленном диске).

FileNotFoundException

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

IOException

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

PathTooLongException

path превышает определенную системой максимальную длину.

SecurityException

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

UnauthorizedAccessException

path указывает файл, доступный только для чтения.

-или-

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

-или-

path — это каталог.

-или-

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

Примеры

В следующем примере считываются строки файла для поиска строк, содержащих указанные строки.

C#

foreach (string line in File.ReadLines(@"d:\data\episodes.txt"))
{
    if (line.Contains("episode") & line.Contains("2006"))
    {
        Console.WriteLine(line);
    }
}

В следующем примере используется метод ReadLines в запросе LINQ, который перечисляет все каталоги для файлов с расширением .txt, считывает каждую строку файла и отображает строку, если она содержит строку "Майкрософт".

C#

using System;
using System.IO;
using System.Linq;

class Program
{
    static void Main(string[] args)
    {
        try
        {
            // Set a variable to the My Documents path.
            string docPath =
            Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);

            var files = from file in Directory.EnumerateFiles(docPath, "*.txt", SearchOption.AllDirectories)
                        from line in File.ReadLines(file)
                        where line.Contains("Microsoft")
                        select new
                        {
                            File = file,
                            Line = line
                        };

            foreach (var f in files)
            {
                Console.WriteLine($"{f.File}\t{f.Line}");
            }
            Console.WriteLine($"{files.Count().ToString()} files found.");
        }
        catch (UnauthorizedAccessException uAEx)
        {
            Console.WriteLine(uAEx.Message);
        }
        catch (PathTooLongException pathEx)
        {
            Console.WriteLine(pathEx.Message);
        }
    }
}

Комментарии

Методы ReadLines и ReadAllLines отличаются следующим образом: при использовании ReadLinesможно начать перечисление коллекции строк перед возвратом всей коллекции; при использовании ReadAllLinesнеобходимо ожидать возврата всего массива строк, прежде чем получить доступ к массиву. Поэтому при работе с очень большими файлами ReadLines может быть более эффективным.

Для выполнения следующих действий можно использовать метод ReadLines.

• Выполните LINQ to Objects запросы к файлу, чтобы получить отфильтрованный набор строк.

• Напишите возвращаемую коллекцию строк в файл с помощью метода File.WriteAllLines(String, IEnumerable<String>) или добавьте их в существующий файл с помощью метода File.AppendAllLines(String, IEnumerable<String>).

• Создайте немедленно заполненный экземпляр коллекции, которая принимает коллекцию строк IEnumerable<T> для конструктора, например IList<T> или Queue<T>.

Этот метод использует UTF8 для значения кодирования.