File.WriteAllText File.WriteAllText File.WriteAllText File.WriteAllText Method

定義

新しいファイルを作成し、内容をそのファイルに書き込んだ後、ファイルを閉じます。Creates a new file, write the contents to the file, and then closes the file. 既存のターゲット ファイルは上書きされます。If the target file already exists, it is overwritten.

オーバーロード

WriteAllText(String, String) WriteAllText(String, String) WriteAllText(String, String) WriteAllText(String, String)

新しいファイルを作成し、指定した文字列をそのファイルに書き込んだ後、ファイルを閉じます。Creates a new file, writes the specified string to the file, and then closes the file. 既存のターゲット ファイルは上書きされます。If the target file already exists, it is overwritten.

WriteAllText(String, String, Encoding) WriteAllText(String, String, Encoding) WriteAllText(String, String, Encoding)

新しいファイルを作成し、指定したエンコーディングで指定の文字列をそのファイルに書き込んだ後、ファイルを閉じます。Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. 既存のターゲット ファイルは上書きされます。If the target file already exists, it is overwritten.

WriteAllText(String, String) WriteAllText(String, String) WriteAllText(String, String) WriteAllText(String, String)

新しいファイルを作成し、指定した文字列をそのファイルに書き込んだ後、ファイルを閉じます。Creates a new file, writes the specified string to the file, and then closes the file. 既存のターゲット ファイルは上書きされます。If the target file already exists, it is overwritten.

public:
 static void WriteAllText(System::String ^ path, System::String ^ contents);
public static void WriteAllText (string path, string contents);
static member WriteAllText : string * string -> unit
Public Shared Sub WriteAllText (path As String, contents As String)

パラメーター

path
String String String String

書き込み先のファイル。The file to write to.

contents
String String String String

ファイルに書き込む文字列。The string to write to 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.

指定したパス、ファイル名、またはその両方がシステム定義の最大長を超えています。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- path によって、非表示のファイルが指定されました。path specified a file that is hidden.

- または --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 の形式が正しくありません。path is in an invalid format.

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

次のコード例は、 WriteAllTextメソッドを使用してファイルにテキストを書き込む方法を示しています。The following code example demonstrates the use of the WriteAllText method to write text to 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

注釈

このメソッドは、バイト順マーク (BOM) なしで utf-8 エンコーディングを使用します。 GetPreambleそのため、メソッドを使用すると、空のバイト配列が返されます。This method uses UTF-8 encoding without a Byte-Order Mark (BOM), so using the GetPreamble method will return an empty byte array. ファイルの先頭に utf-8 識別子 (バイトオーダーマークなど) を含める必要がある場合は、エンコードでWriteAllText(String, String, Encoding) UTF8メソッドオーバーロードを使用します。If it is necessary to include a UTF-8 identifier, such as a byte order mark, at the beginning of a file, use the WriteAllText(String, String, Encoding) method overload with UTF8 encoding.

このメソッドは、文字列とファイルパスを指定して、指定されたファイルを開き、その文字列をファイルに書き込んだ後、ファイルを閉じます。Given a string and a file path, this method opens the specified file, writes the string to the file, and then closes the file.

セキュリティ

FileIOPermission
ファイルまたはディレクトリに書き込むためのアクセス許可。for access to write to a file or directory. 関連付けられた列挙型:WriteAssociated enumeration: Write

WriteAllText(String, String, Encoding) WriteAllText(String, String, Encoding) WriteAllText(String, String, Encoding)

新しいファイルを作成し、指定したエンコーディングで指定の文字列をそのファイルに書き込んだ後、ファイルを閉じます。Creates a new file, writes the specified string to the file using the specified encoding, and then closes the file. 既存のターゲット ファイルは上書きされます。If the target file already exists, it is overwritten.

public:
 static void WriteAllText(System::String ^ path, System::String ^ contents, System::Text::Encoding ^ encoding);
public static void WriteAllText (string path, string contents, System.Text.Encoding encoding);
static member WriteAllText : string * string * System.Text.Encoding -> unit

パラメーター

path
String String String String

書き込み先のファイル。The file to write to.

contents
String String String String

ファイルに書き込む文字列。The string to write to the file.

encoding
Encoding Encoding Encoding Encoding

文字列に適用するエンコーディング。The encoding to apply to the string.

例外

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.

指定したパス、ファイル名、またはその両方がシステム定義の最大長を超えています。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- path によって、非表示のファイルが指定されました。path specified a file that is hidden.

- または --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 の形式が正しくありません。path is in an invalid format.

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

次のコード例は、 WriteAllTextメソッドを使用してファイルにテキストを書き込む方法を示しています。The following code example demonstrates the use of the WriteAllText method to write text to 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

注釈

文字列とファイルパスが指定されている場合、このメソッドは指定されたファイルを開き、指定されたエンコーディングを使用して文字列をファイルに書き込んだ後、ファイルを閉じます。Given a string and a file path, this method opens the specified file, writes the string to the file using the specified encoding, and then closes the file. 例外が発生した場合でも、ファイルハンドルはこのメソッドによって閉じられることが保証されます。The file handle is guaranteed to be closed by this method, even if exceptions are raised.

セキュリティ

FileIOPermission
ファイルまたはディレクトリに書き込むためのアクセス許可。for access to write to a file or directory. 関連付けられた列挙型:WriteAssociated enumeration: Write

適用対象