Export (0) Print
Expand All

FileSystem.DeleteDirectory Method (String, UIOption, RecycleOption, UICancelOption)

Deletes a directory.

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

public static void DeleteDirectory(
	string directory,
	UIOption showUI,
	RecycleOption recycle,
	UICancelOption onUserCancel
)

Parameters

directory
Type: System.String

Directory to be deleted.

showUI
Type: Microsoft.VisualBasic.FileIO.UIOption

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

recycle
Type: Microsoft.VisualBasic.FileIO.RecycleOption

Specifies whether or not the deleted file should be sent to the Recycle Bin. Default is RecycleOption.DeletePermanently.

onUserCancel
Type: Microsoft.VisualBasic.FileIO.UICancelOption

Specifies whether to throw an exception if the user clicks Cancel.

ExceptionCondition
ArgumentException

The path is a zero-length string, is malformed, contains only white space, or contains invalid characters (including wildcard characters). The path is a device path (starts with \\.\).

ArgumentNullException

directory is Nothing or an empty string.

DirectoryNotFoundException

The directory does not exist or is a file.

IOException

The directory is not empty, and onDirectoryNotEmpty is set to ThrowIfDirectoryNonEmpty.

IOException

The user does not have permission to delete the directory or subdirectory.

IOException

A file in the directory or subdirectory is in use.

NotSupportedException

The directory name contains a colon (:).

PathTooLongException

The path exceeds the system-defined maximum length.

SecurityException

The user does not have required permissions.

OperationCanceledException

The user cancels the operation or the directory cannot be deleted.

The showUI, recycle, and onUserCancel parameters are not supported in applications that are not user interactive, such as Windows Services.

The example deletes the directory OldDirectory only if it is empty.

My.Computer.FileSystem.DeleteDirectory(
  "C:\OldDirectory",
  FileIO.DeleteDirectoryOption.ThrowIfDirectoryNonEmpty)

This example deletes the directory OldDirectory and all of its contents.

My.Computer.FileSystem.DeleteDirectory(
  "C:\OldDirectory",
  FileIO.DeleteDirectoryOption.DeleteAllContents)

This example deletes the directory OldDirectory and all of its contents, asking the user to confirm the deletion, but does not send the contents to the Recycle Bin.

My.Computer.FileSystem.DeleteDirectory(
  "C:\OldDirectory",
  FileIO.UIOption.AllDialogs,
  FileIO.RecycleOption.DeletePermanently,
  FileIO.UICancelOption.ThrowException)

This example deletes the directory OldDirectory and all of its contents, sending them to the Recycle Bin, but does not show the progress of the operation.

My.Computer.FileSystem.DeleteDirectory(
 "C:\OldDirectory",
 FileIO.UIOption.AllDialogs,
 FileIO.RecycleOption.SendToRecycleBin,
 FileIO.UICancelOption.ThrowException)

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft