FileInfo.Replace メソッド

定義

名前空間:

System.IO

アセンブリ:

System.Runtime.dll

指定したファイルの内容を、現在の FileInfo オブジェクトによって記述されたファイルに置き換え、元のファイルを削除し、置き換えられたファイルのバックアップを作成します。

オーバーロード

Replace(String, String)	指定したファイルの内容を、現在の FileInfo オブジェクトによって記述されたファイルに置き換え、元のファイルを削除し、置き換えられたファイルのバックアップを作成します。
Replace(String, String, Boolean)	指定したファイルの内容を、現在の FileInfo オブジェクトによって記述されたファイルに置き換え、元のファイルを削除し、置き換えられたファイルのバックアップを作成します。 また、マージ エラーを無視するかどうかを指定します。

注釈

Replace メソッドは、ファイルを現在の FileInfo オブジェクトで記述されているファイルの内容にすばやく置き換える必要がある場合に使用します。

Replace(String, String)

ソース:

FileInfo.cs

指定したファイルの内容を、現在の FileInfo オブジェクトによって記述されたファイルに置き換え、元のファイルを削除し、置き換えられたファイルのバックアップを作成します。

C#

public System.IO.FileInfo Replace (string destinationFileName, string? destinationBackupFileName);

パラメーター

destinationFileName

String

現在のファイルに置き換えるファイルの名前。

destinationBackupFileName

String

destinationFileName パラメーターによって記述されたファイルのバックアップを作成するファイルの名前。

戻り値

FileInfo

destinationFileName パラメーターによって記述されたファイルに関する情報をカプセル化する FileInfo オブジェクト。

例外

ArgumentException

destinationFileName パラメーターによって記述されたパスは、有効な形式ではありません。

-又は-

destinationBackupFileName パラメーターによって記述されたパスは、有効な形式ではありません。

ArgumentNullException

destinationFileName パラメーターは nullです。

FileNotFoundException

現在の FileInfo オブジェクトによって記述されたファイルが見つかりませんでした。

-又は-

destinationFileName パラメーターによって記述されたファイルが見つかりませんでした。

PlatformNotSupportedException

現在のオペレーティング システムが Microsoft Windows NT 以降ではありません。

例

次の例では、Replace メソッドを使用してファイルを別のファイルに置き換え、置き換えられたファイルのバックアップを作成します。

C#

using System;
using System.IO;

namespace FileSystemExample
{
    class FileExample
    {
        public static void Main()
        {
            try
            {
                // originalFile and fileToReplace must contain the path to files that already exist in the
                // file system. backUpOfFileToReplace is created during the execution of the Replace method.

                string originalFile  = "test.txt";
                string fileToReplace = "test2.txt";
                string backUpOfFileToReplace = "test2.txt.bak";

                if (File.Exists(originalFile) && (File.Exists(fileToReplace)))
                {
                    Console.WriteLine("Move the contents of " + originalFile + " into " + fileToReplace + ", delete "
                        + originalFile + ", and create a backup of " + fileToReplace + ".");

                    // Replace the file.
                    ReplaceFile(originalFile, fileToReplace, backUpOfFileToReplace);

                    Console.WriteLine("Done");
                }
                else
                {
                    Console.WriteLine("Either the file {0} or {1} doesn't " + "exist.", originalFile, fileToReplace);
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }

            Console.ReadLine();
        }

        // Move a file into another file, delete the original, and create a backup of the replaced file.
        public static void ReplaceFile(string fileToMoveAndDelete, string fileToReplace, string backupOfFileToReplace)
        {
            // Create a new FileInfo object.
            FileInfo fInfo = new FileInfo(fileToMoveAndDelete);

            // replace the file.
            fInfo.Replace(fileToReplace, backupOfFileToReplace, false);
        }
    }
}
//Move the contents of test.txt into test2.txt, delete test.txt, and
//create a backup of test2.txt.
//Done

注釈

Replace メソッドは、指定したファイルの内容を、現在の FileInfo オブジェクトによって記述されたファイルの内容に置き換えます。 また、置き換えられたファイルのバックアップも作成されます。 最後に、上書きされたファイルを記述する新しい FileInfo オブジェクトを返します。

置き換えられるファイルのバックアップを作成しない場合は、null を destinationBackupFileName パラメーターに渡します。

Replace(String, String, Boolean)

ソース:

FileInfo.cs

指定したファイルの内容を、現在の FileInfo オブジェクトによって記述されたファイルに置き換え、元のファイルを削除し、置き換えられたファイルのバックアップを作成します。 また、マージ エラーを無視するかどうかを指定します。

C#

public System.IO.FileInfo Replace (string destinationFileName, string? destinationBackupFileName, bool ignoreMetadataErrors);

パラメーター

destinationFileName

String

現在のファイルに置き換えるファイルの名前。

destinationBackupFileName

String

destinationFileName パラメーターによって記述されたファイルのバックアップを作成するファイルの名前。

ignoreMetadataErrors

Boolean

置換されたファイルから置換ファイルへのマージ エラー (属性や ACL など) を無視する true。それ以外の場合は false。

戻り値

FileInfo

destinationFileName パラメーターによって記述されたファイルに関する情報をカプセル化する FileInfo オブジェクト。

例外

ArgumentException

destinationFileName パラメーターによって記述されたパスは、有効な形式ではありません。

-又は-

destinationBackupFileName パラメーターによって記述されたパスは、有効な形式ではありません。

ArgumentNullException

destinationFileName パラメーターは nullです。

FileNotFoundException

現在の FileInfo オブジェクトによって記述されたファイルが見つかりませんでした。

-又は-

destinationFileName パラメーターによって記述されたファイルが見つかりませんでした。

PlatformNotSupportedException

現在のオペレーティング システムが Microsoft Windows NT 以降ではありません。

例

次の例では、Replace メソッドを使用してファイルを別のファイルに置き換え、置き換えられたファイルのバックアップを作成します。

C#

using System;
using System.IO;

namespace FileSystemExample
{
    class FileExample
    {
        public static void Main()
        {
            try
            {
                // originalFile and fileToReplace must contain the path to files that already exist in the
                // file system. backUpOfFileToReplace is created during the execution of the Replace method.

                string originalFile  = "test.txt";
                string fileToReplace = "test2.txt";
                string backUpOfFileToReplace = "test2.txt.bak";

                if (File.Exists(originalFile) && (File.Exists(fileToReplace)))
                {
                    Console.WriteLine("Move the contents of " + originalFile + " into " + fileToReplace + ", delete "
                        + originalFile + ", and create a backup of " + fileToReplace + ".");

                    // Replace the file.
                    ReplaceFile(originalFile, fileToReplace, backUpOfFileToReplace);

                    Console.WriteLine("Done");
                }
                else
                {
                    Console.WriteLine("Either the file {0} or {1} doesn't " + "exist.", originalFile, fileToReplace);
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }

            Console.ReadLine();
        }

        // Move a file into another file, delete the original, and create a backup of the replaced file.
        public static void ReplaceFile(string fileToMoveAndDelete, string fileToReplace, string backupOfFileToReplace)
        {
            // Create a new FileInfo object.
            FileInfo fInfo = new FileInfo(fileToMoveAndDelete);

            // replace the file.
            fInfo.Replace(fileToReplace, backupOfFileToReplace, false);
        }
    }
}
//Move the contents of test.txt into test2.txt, delete test.txt, and
//create a backup of test2.txt.
//Done

注釈

Replace メソッドは、指定したファイルの内容を、現在の FileInfo オブジェクトによって記述されたファイルの内容に置き換えます。 また、置き換えられたファイルのバックアップも作成されます。 最後に、上書きされたファイルを記述する新しい FileInfo オブジェクトを返します。

置き換えられるファイルのバックアップを作成しない場合は、null を destinationBackupFileName パラメーターに渡します。