Export (0) Print
Expand All

File.Replace Method (String, String, String, Boolean)

Replaces the contents of a specified file with the contents of another file, deleting the original file, and creating a backup of the replaced file and optionally ignores merge errors.

Namespace:  System.IO
Assembly:  mscorlib (in mscorlib.dll)

public static function Replace(
	sourceFileName : String, 
	destinationFileName : String, 
	destinationBackupFileName : String, 
	ignoreMetadataErrors : boolean
)

Parameters

sourceFileName
Type: System.String

The name of a file that replaces the file specified by destinationFileName.

destinationFileName
Type: System.String

The name of the file being replaced.

destinationBackupFileName
Type: System.String

The name of the backup file.

ignoreMetadataErrors
Type: System.Boolean

true to ignore merge errors (such as attributes and access control lists (ACLs)) from the replaced file to the replacement file; otherwise, false.

ExceptionCondition
ArgumentException

The path described by the destinationFileName parameter was not of a legal form.

-or-

The path described by the destinationBackupFileName parameter was not of a legal form.

ArgumentNullException

The destinationFileName parameter is a null reference (Nothing in Visual Basic).

DriveNotFoundException

An invalid drive was specified.

FileNotFoundException

The file described by the current FileInfo object could not be found.

-or-

The file described by the destinationBackupFileName parameter could not be found.

IOException

An I/O error occurred while opening the file.

- or -

The sourceFileName and destinationFileName parameters specify the same file.

PathTooLongException

The specified path, file name, or both exceed the system-defined maximum length. For example, on Windows-based platforms, paths must be less than 248 characters, and file names must be less than 260 characters.

PlatformNotSupportedException

The operating system is Windows 98 Second Edition or earlier and the files system is not NTFS.

UnauthorizedAccessException

The sourceFileName or destinationFileName parameter specifies a file that is read-only.

-or-

This operation is not supported on the current platform.

-or-

Source or destination parameters specify a directory instead of a file.

-or-

The caller does not have the required permission.

The Replace method replaces the contents of a specified file with the contents of another file. It also creates a backup of the file that was replaced.

If the sourceFileName and destinationFileName are on different volumes, this method will raise an exception. If the destinationBackupFileName is on a different volume from the source file, the backup file will be deleted.

Pass a null reference (Nothing in Visual Basic) to the destinationBackupFileName parameter if you do not want to create a backup of the file being replaced.

The following code example uses the Replace method to replace a file with another file and create a backup of the replaced file.

No code example is currently available or this language may not be supported.

  • FileIOPermission 

    for permission to read and write to the file described by the sourceFileName parameter. Associated enumeration: Read

    Security action: Demand.

  • FileIOPermission 

    for permission to read and write to the file described by the destinationFileName parameter. Associated enumerations: Read , Write

    Security action: Demand.

  • FileIOPermission 

    for permission to write to file described by the destinationBackupFileName parameter if one is specified. Associated enumeration: Write

    Security action: Demand.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft