MoveTo Method (IWritableFileInfo)

Moves a specified file to a new location, providing the options to specify a new file name and to overwrite the destination file if it already exists.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Sub MoveTo( _
   ByVal destinationFilePathAndName As String, _
   ByVal overwrite As Boolean _
)

'Usage
 
Dim instance As IWritableFileInfo
Dim destinationFilePathAndName As String
Dim overwrite As Boolean
 
instance.MoveTo(destinationFilePathAndName, overwrite)

void MoveTo( 
   string destinationFilePathAndName,
   bool overwrite
)

void MoveTo( 
   String^ destinationFilePathAndName,
   bool overwrite
)

Parameters

destinationFilePathAndName: The path to move the file to, which can specify a different file name.
overwrite: true to overwrite the destination file if it already exists; false otherwise.

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.DirectoryNotFoundException	Part of a file or directory cannot be found. 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.IO.FileNotFoundException	An attempt to access a file that does not exist on disk has failed. 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.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.IO.PathTooLongException	A path or fully qualified file name is longer than the system-defined maximum length. 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.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.MoveTo(System.String), but is generalized for any kind of writable file info, not just files in the physical file system.

You can use this method to rename a file, keeping it in the same parent directory, too. It is recommended to use the IWritableFileInfoExtension.Rename method if your intent is renaming and not moving. The IWritableFileInfoExtension.Rename has additional checks that guarantee that renaming and not moving will occur.

This method can be used with an absolute path pointing in destinationFilePathAndName.

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.

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

IWritableFileInfo Interface
IWritableFileInfo Members
CopyTo Method
OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfoExtension.MoveTo(OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo,System.String)

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