Replace(IWritableFileInfo,String,String) Method

Replaces the contents of a specified file with the file described by the current IWritableFileInfo object, deleting the original file, and creating a backup of the replaced file.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub Replace( _
   ByVal writableFileInfo As IWritableFileInfo, _
   ByVal destinationFilePathAndName As String, _
   ByVal destinationBackupFilePathAndName As String _
)

'Usage
 
Dim writableFileInfo As IWritableFileInfo
Dim destinationFilePathAndName As String
Dim destinationBackupFilePathAndName As String
 
IWritableFileInfoExtension.Replace(writableFileInfo, destinationFilePathAndName, destinationBackupFilePathAndName)

[Extension()]
public static void Replace( 
   IWritableFileInfo writableFileInfo,
   string destinationFilePathAndName,
   string destinationBackupFilePathAndName
)

[Extension()]
public:
static void Replace( 
   IWritableFileInfo^ writableFileInfo,
   String^ destinationFilePathAndName,
   String^ destinationBackupFilePathAndName
)

Parameters

writableFileInfo: The writable file info object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
destinationFilePathAndName: The name of a file to replace with the current file.
The value of this parameter cannot be null (Nothing in Visual Basic).
destinationBackupFilePathAndName: The name of a file with which to create a backup of the file described by the destinationFilePathAndName parameter.
The value of this parameter can be null (Nothing in Visual Basic).

Exceptions

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This method is similar in purpose to System.IO.FileInfo.Replace(System.String,System.String), but is generalized for any kind of writable file info, not just files in the physical file system.

The Replace(IWritableFileInfo,String,String) method replaces the contents of a specified file with the contents of the file described by the current IWritableFileInfo object. It also optionally creates a backup of the file that was replaced.

Pass null to the destinationBackupFilePathAndName parameter if you do not want to create a backup of the file being replaced.

For Microsoft.Extensions.FileProviders.IFileInfo, IFileInfo2 and IWritableFileInfo, relative paths are based on the directory where the file is located; absolute paths are based on the root directory of the file provider.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IWritableFileInfoExtension Class
IWritableFileInfoExtension Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.