FileSystem.RenameDirectory(String, String) Method

Reference

Definition

Namespace:: Microsoft.VisualBasic.FileIO

Assembly:: Microsoft.VisualBasic.Core.dll

Assembly:: Microsoft.VisualBasic.dll

Source:: FileSystem.vb

Source:: FileSystem.vb

Source:: FileSystem.vb

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Renames a directory.

public:
 static void RenameDirectory(System::String ^ directory, System::String ^ newName);

public static void RenameDirectory (string directory, string newName);

static member RenameDirectory : string * string -> unit

Public Shared Sub RenameDirectory (directory As String, newName As String)

Parameters

directory: String

Path and name of directory to be renamed.

newName: String

New name for directory.

Exceptions

ArgumentException

newName contains path information.

ArgumentNullException

directory is Nothing.

-or-

newName is Nothing or an empty string.

DirectoryNotFoundException

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 Test directory to SecondTest.

My.Computer.FileSystem.RenameDirectory("C:MyDocuments\Test", "SecondTest")

Remarks

This method cannot be used to move a directory; use the MoveDirectory method to move and rename the directory.

Applies to

Jaa