FileSystem.RenameFile Method (String, String)

 

Renames a file.

Namespace:   Microsoft.VisualBasic.FileIO
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

public static void RenameFile(
	string file,
	string newName
)

Parameters

file
Type: System.String

File to be renamed.

newName
Type: System.String

New name of file.

Exception Condition
ArgumentException

The path is not valid for one of the following reasons: it is a zero-length string; it contains only white space; it contains invalid characters; or it is a device path (starts with \\.\).

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.

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

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.

FileIOPermission

Controls the ability to access files and folders. Associated enumeration: Unrestricted.

.NET Framework
Available since 2.0
Return to top
Show: