MoveFile

Moves a file to a new location.


Syntax

FileSystem.MoveFile(SourceFile, DestinationFile)

FileSystem.MoveFile(SourceFile, DestinationFile, Overwrite)

FileSystem.MoveFile(SourceFile, DestinationFile, UIOption)

FileSystem.MoveFile(SourceFile, DestinationFile, UIOption, UICancelOption)


Parameters


SourceFile

String, input



Path of the file to be moved.


DestinationFile

String, input



Path of the directory into which the file should be moved.


Overwrite

Boolean, input



True if existing file should be overwritten; otherwise False. Default is False.


UIOption

Enumeration, input



Whether to visually track the operation's progress. Default is OnlyErrorDialogs.


UICancelOption

Enumeration, input



Specifies what should be done if the user clicks Cancel during the operation. Default is ThrowException.


Remarks


UIOption



UIOption.AllDialogs

Show progress dialog box and any error dialog boxes.


UIOption.OnlyErrorDialogs

Only show error dialog boxes and hide progress dialog boxes. Default.


UICancelOption



UICancelOption.DoNothing

Do nothing when the user clicks Cancel.


UICancelOption.ThrowException

Throw an exception when the user clicks Cancel. Default.


Examples


This example moves the specified file from one directory to another:


Sub Main()

FileSystem.MoveFile "C:\Users\Public\My Directory\Test.txt", "C:\Users\Public\Test Directory\Test.txt"

End Sub


This example move the specified file from one directory to another and renames the file:


Sub Main()

FileSystem.MoveFile "C:\Users\Public\My Directory\Test.txt", "C:\Users\Public\Test Directory\NewTest.txt"

End Sub