FileSystem.RenameFile(String, String) Method

Definition

Namespace:

Microsoft.VisualBasic.FileIO

Assembly:

Microsoft.VisualBasic.Core.dll

Source:

FileSystem.vb

Renames a file.

public:
 static void RenameFile(System::String ^ file, System::String ^ newName);

public static void RenameFile (string file, string newName);

static member RenameFile : string * string -> unit

Public Shared Sub RenameFile (file As String, newName As String)

Parameters

file

String

File to be renamed.

newName

String

New name of file.

Exceptions

ArgumentException

newName contains path information or ends with a backslash (\).

ArgumentNullException

file is Nothing.

-or-

newName is Nothing or an empty string.

FileNotFoundException

The directory does not exist.

IOException

There is an existing file or directory with the name specified in newName.

PathTooLongException

The path exceeds the system-defined maximum length.

NotSupportedException

A file or directory name in the path contains a colon (:) or is in an invalid format.

SecurityException

The user lacks necessary permissions to view the path.

UnauthorizedAccessException

The user does not have required permission.

Examples

This example renames the file Test.txt to SecondTest.txt.

My.Computer.FileSystem.RenameFile("C:\Test.txt", "SecondTest.txt")

Change "C:\Test.txt" to the path and file name of the file that you want to rename.

Remarks

This method cannot be used to move a file; use the MoveFile method to move and rename the file.

The following table lists an example of a task involving the My.Computer.FileSystem.RenameFile method.

To	See
Rename a file	How to: Rename a File in Visual Basic