Edit

Share via


FileSystemProxy.RenameFile(String, String) Method

Definition

Renames a file.

public:
 void RenameFile(System::String ^ file, System::String ^ newName);
public void RenameFile (string file, string newName);
member this.RenameFile : string * string -> unit
Public Sub RenameFile (file As String, newName As String)

Parameters

file
String

File to be renamed.

newName
String

New name of file.

Exceptions

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

file is Nothing.

-or-

newName is Nothing or an empty string.

The file does not exist.

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

The path exceeds the system-defined maximum length.

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

The user lacks necessary permissions to view the path.

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

Applies to

See also