CopyDirectory Method (String, String, UIOption, UICancelOption)

FileSystem.CopyDirectory Method (String, String, UIOption, UICancelOption)


Copies the contents of a directory to another directory.

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

public static void CopyDirectory(
	string sourceDirectoryName,
	string destinationDirectoryName,
	UIOption showUI,
	UICancelOption onUserCancel


Type: System.String

The directory to be copied.

Type: System.String

The location to which the directory contents should be copied.

Type: Microsoft.VisualBasic.FileIO.UIOption

Whether to visually track the operation's progress. Default is UIOption.OnlyErrorDialogs.

Type: Microsoft.VisualBasic.FileIO.UICancelOption

Specifies what should be done if the user clicks Cancel during the operation. Default is ThrowException.

Exception Condition

The new name specified for the directory contains a colon (:) or slash (\ or /).


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 \\.\).


destinationDirectoryName or sourceDirectoryName is Nothing or an empty string.


The source directory does not exist.


The source directory is a root directory


The combined path points to an existing file.


The source path and target path are the same.


The operation is cyclic.


The path exceeds the system-defined maximum length.


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


The user lacks necessary permissions to view the path.


A destination file exists but cannot be accessed.


ShowUI is set to UIOption.AllDialogs and the user cancels the operation, or one or more files in the directory cannot be copied.

This method copies the contents of the source directory to the target directory. If the target directory does not exist, it is created. If a directory with the same name exists in the target location, the contents of the two directories are merged. You can specify a new name for the directory during the operation.

When copying files within a directory, exceptions may be thrown that are caused by a specific file. When such exceptions are thrown, they are consolidated into a single exception whose Data property holds entries in the form of an IDictionary in which the file or directory path is the key and the specific exception message is contained in the corresponding value. Use For…Each to enumerate through the entries.

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



Copy a directory

How to: Copy a Directory to Another Directory in Visual Basic

The following example copies the contents of directory TestDirectory1 into TestDirectory2, overwriting existing files.

My.Computer.FileSystem.CopyDirectory("C:\TestDirectory1", "C:\TestDirectory2", True)

Replace C:\TestDirectory1 and C:\TestDirectory2 with the path and name of the directory you wish to copy and the location to which you wish to copy it.


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


Controls the permissions related to user interfaces and the clipboard. Associated enumeration: SafeSubWindows.

.NET Framework
Available since 2.0
Return to top
© 2015 Microsoft