File.ReadAllText メソッド

定義

テキスト ファイルを開き、そのファイル内のすべてのテキストを文字列に読み取った後、ファイルを閉じます。Opens a text file, reads all the text in the file into a string, and then closes the file.

オーバーロード

ReadAllText(String, Encoding)

ファイルを開き、指定したエンコードを使ってファイル内のすべてのテキストを読み取った後、ファイルを閉じます。Opens a file, reads all text in the file with the specified encoding, and then closes the file.

ReadAllText(String)

テキスト ファイルを開き、そのファイル内のすべてのテキストを読み取った後、ファイルを閉じます。Opens a text file, reads all the text in the file, and then closes the file.

ReadAllText(String, Encoding)

ファイルを開き、指定したエンコードを使ってファイル内のすべてのテキストを読み取った後、ファイルを閉じます。Opens a file, reads all text in the file with the specified encoding, and then closes the file.

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

読み取り用に開かれるファイル。The file to open for reading.

encoding
Encoding

ファイルの内容に適用されるエンコーディング。The encoding applied to the contents of the file.

戻り値

String

ファイル内のすべてのテキストを含んでいる文字列。A string containing all text in the file.

例外

path は長さ 0 の文字列であるか、空白のみで構成されるか、または InvalidPathChars で定義される 1 つ以上の使用できない文字を含んでいます。path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.

pathnullです。path is null.

指定したパス、ファイル名、またはその両方がシステム定義の最大長を超えています。The specified path, file name, or both exceed the system-defined maximum length.

指定されたパスが正しくありません (たとえば、マップされていないドライブにあるなど)。The specified path is invalid (for example, it is on an unmapped drive).

ファイルを開くときに、I/O エラーが発生しました。An I/O error occurred while opening the file.

path が読み取り専用のファイルを指定しました。path specified a file that is read-only.

- または --or- この操作は、現在のプラットフォームではサポートされていません。This operation is not supported on the current platform.

- または --or- path がディレクトリを指定しました。path specified a directory.

- または --or- 呼び出し元に、必要なアクセス許可がありません。The caller does not have the required permission.

path で指定されたファイルが見つかりませんでした。The file specified in path was not found.

path の形式が正しくありません。path is in an invalid format.

呼び出し元に、必要なアクセス許可がありません。The caller does not have the required permission.

次のコード例は、メソッドを使用して ReadAllText ファイルの内容を表示する方法を示しています。The following code example demonstrates the use of the ReadAllText method to display the contents of a file. この例では、ファイルがまだ存在していない場合は作成され、テキストが追加されます。In this example a file is created, if it doesn't already exist, and text is added to it.

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

注釈

このメソッドは、ファイルを開き、ファイル内のすべてのテキストを読み取って、文字列として返します。This method opens a file, reads all the text in the file, and returns it as a string. その後、ファイルを閉じます。It then closes the file.

このメソッドは、バイトオーダーマークの有無に基づいて、ファイルのエンコーディングを自動的に検出しようとします。This method attempts to automatically detect the encoding of a file based on the presence of byte order marks. UTF-8 と 32 UTF-8 のエンコード形式 (ビッグエンディアンとリトルエンディアンの両方) を検出できます。Encoding formats UTF-8 and UTF-32 (both big-endian and little-endian) can be detected.

例外が発生した場合でも、ファイルハンドルはこのメソッドによって閉じられることが保証されます。The file handle is guaranteed to be closed by this method, even if exceptions are raised.

オペレーティングシステム用に構成されているエンコード設定を使用するには、 Encoding.Default パラメーターのプロパティを指定し encoding ます。To use the encoding settings as configured for your operating system, specify the Encoding.Default property for the encoding parameter.

こちらもご覧ください

適用対象

ReadAllText(String)

テキスト ファイルを開き、そのファイル内のすべてのテキストを読み取った後、ファイルを閉じます。Opens a text file, reads all the text in the file, and then closes the file.

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

読み取り用に開かれるファイル。The file to open for reading.

戻り値

String

ファイル内のすべてのテキストを含んでいる文字列。A string containing all the text in the file.

例外

path は長さ 0 の文字列であるか、空白のみで構成されるか、または InvalidPathChars で定義される 1 つ以上の使用できない文字を含んでいます。path is a zero-length string, contains only white space, or contains one or more invalid characters as defined by InvalidPathChars.

pathnullです。path is null.

指定したパス、ファイル名、またはその両方がシステム定義の最大長を超えています。The specified path, file name, or both exceed the system-defined maximum length.

指定されたパスが正しくありません (たとえば、マップされていないドライブにあるなど)。The specified path is invalid (for example, it is on an unmapped drive).

ファイルを開くときに、I/O エラーが発生しました。An I/O error occurred while opening the file.

path が読み取り専用のファイルを指定しました。path specified a file that is read-only.

- または --or- この操作は、現在のプラットフォームではサポートされていません。This operation is not supported on the current platform.

- または --or- path がディレクトリを指定しました。path specified a directory.

- または --or- 呼び出し元に、必要なアクセス許可がありません。The caller does not have the required permission.

path で指定されたファイルが見つかりませんでした。The file specified in path was not found.

path の形式が正しくありません。path is in an invalid format.

呼び出し元に、必要なアクセス許可がありません。The caller does not have the required permission.

次のコード例は、メソッドを使用して ReadAllText ファイルの内容を表示する方法を示しています。The following code example demonstrates the use of the ReadAllText method to display the contents of a file. この例では、ファイルがまだ存在していない場合は作成され、テキストが追加されます。In this example a file is created, if it doesn't already exist, and text is added to it.

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

注釈

このメソッドは、ファイルを開き、ファイル内のすべてのテキストを読み取って、文字列として返します。This method opens a file, reads all the text in the file, and returns it as a string. その後、ファイルを閉じます。It then closes the file.

このメソッドは、バイトオーダーマークの有無に基づいて、ファイルのエンコーディングを自動的に検出しようとします。This method attempts to automatically detect the encoding of a file based on the presence of byte order marks. UTF-8 と 32 UTF-8 のエンコード形式 (ビッグエンディアンとリトルエンディアンの両方) を検出できます。Encoding formats UTF-8 and UTF-32 (both big-endian and little-endian) can be detected.

ReadAllText(String, Encoding)認識されない文字が正しく読み取られない可能性があるため、インポートされたテキストを含む可能性があるファイルを読み取る場合は、メソッドオーバーロードを使用します。Use the ReadAllText(String, Encoding) method overload when reading files that might contain imported text, because unrecognized characters may not be read correctly.

例外が発生した場合でも、ファイルハンドルはこのメソッドによって閉じられることが保証されます。The file handle is guaranteed to be closed by this method, even if exceptions are raised.

こちらもご覧ください

適用対象