This topic has not yet been rated - Rate this topic

FileSystem.Rename Method

.NET Framework 3.5

Renames a disk file or directory. The My feature gives you better productivity and performance in file I/O operations than Rename. For more information, see My.Computer.FileSystem Object.

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

Syntax

C++

JScript

public static void Rename(
	string OldPath,
	string NewPath
)

Parameters

OldPath: Type: System.String
Required. String expression that specifies the existing file name and location. OldPath may include the directory, and drive, of the file.

NewPath: Type: System.String
Required. String expression that specifies the new file name and location. NewPath may include directory and drive of the destination location. The file name specified by NewPath cannot already exist.

Remarks

For more detailed information, see the Visual Basic topic Rename Function.

The Rename function renames a file and moves it to a different directory, if it is required. The Rename function can move a file across drives, but it can only rename an existing directory when both NewPath and OldPath are located on the same drive. Rename cannot create a new file or directory.

Using the Rename function on an open file produces an error. You must close an open file before renaming it. Rename arguments cannot include multiple-character (*) and single-character (?) wildcards.

Security Note:
When using Rename to copy a file from an unprotected location to a protected location, the file retains the less restricted rights. Check to make sure that you are not introducing a possible security risk.

Examples

This example uses the Rename function to rename a file. For purposes of this example, assume that the directories that are specified already exist.

Dim OldName, NewName As String
OldName = "OLDFILE" 
' Define file names.
NewName = "NEWFILE" 
' Rename file.
Rename(OldName, NewName)

OldName = "C:\OLDDIR\OLDFILE"
NewName = "C:\NEWDIR\NEWFILE" 
' Move and rename file.
Rename(OldName, NewName)

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information