FileSystemProxy.DeleteDirectory Method
Definition
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.
Deletes a directory.
Overloads
| DeleteDirectory(String, UIOption, RecycleOption) |
Deletes a directory. |
| DeleteDirectory(String, UIOption, RecycleOption, UICancelOption) |
Deletes a directory. |
| DeleteDirectory(String, DeleteDirectoryOption) |
Deletes a directory. |
DeleteDirectory(String, UIOption, RecycleOption)
Deletes a directory.
public:
void DeleteDirectory(System::String ^ directory, Microsoft::VisualBasic::FileIO::UIOption showUI, Microsoft::VisualBasic::FileIO::RecycleOption recycle);public void DeleteDirectory (string directory, Microsoft.VisualBasic.FileIO.UIOption showUI, Microsoft.VisualBasic.FileIO.RecycleOption recycle);member this.DeleteDirectory : string * Microsoft.VisualBasic.FileIO.UIOption * Microsoft.VisualBasic.FileIO.RecycleOption -> unitPublic Sub DeleteDirectory (directory As String, showUI As UIOption, recycle As RecycleOption)Parameters
- directory
- String
Directory to be deleted.
- showUI
- UIOption
Specifies whether to visually track the operation's progress. Default is UIOption.OnlyErrorDialogs.
- recycle
- RecycleOption
Specifies whether or not the deleted file should be sent to the Recycle Bin. Default is RecycleOption.DeletePermanently.
Exceptions
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 \\.\).
directory is Nothing or an empty string.
The directory does not exist or is a file.
A file in the directory or subdirectory is in use.
The directory name contains a colon (:).
The path exceeds the system-defined maximum length.
The user does not have required permissions.
The user cancels the operation or the directory cannot be deleted.
Examples
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)
Remarks
The showUI and recycle parameters are not supported in applications that are not user interactive, such as Windows Services.
See also
Applies to
DeleteDirectory(String, UIOption, RecycleOption, UICancelOption)
Deletes a directory.
public:
void DeleteDirectory(System::String ^ directory, Microsoft::VisualBasic::FileIO::UIOption showUI, Microsoft::VisualBasic::FileIO::RecycleOption recycle, Microsoft::VisualBasic::FileIO::UICancelOption onUserCancel);public void DeleteDirectory (string directory, Microsoft.VisualBasic.FileIO.UIOption showUI, Microsoft.VisualBasic.FileIO.RecycleOption recycle, Microsoft.VisualBasic.FileIO.UICancelOption onUserCancel);member this.DeleteDirectory : string * Microsoft.VisualBasic.FileIO.UIOption * Microsoft.VisualBasic.FileIO.RecycleOption * Microsoft.VisualBasic.FileIO.UICancelOption -> unitPublic Sub DeleteDirectory (directory As String, showUI As UIOption, recycle As RecycleOption, onUserCancel As UICancelOption)Parameters
- directory
- String
Directory to be deleted.
- showUI
- UIOption
Specifies whether to visually track the operation's progress. Default is UIOption.OnlyErrorDialogs.
- recycle
- RecycleOption
Specifies whether or not the deleted file should be sent to the Recycle Bin. Default is RecycleOption.DeletePermanently.
- onUserCancel
- UICancelOption
Specifies whether to throw an exception if the user clicks Cancel.
Exceptions
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 \\.\).
directory is Nothing or an empty string.
The directory does not exist or is a file.
A file in the directory or subdirectory is in use.
The directory name contains a colon (:).
The path exceeds the system-defined maximum length.
The user does not have required permissions.
The user cancels the operation or the directory cannot be deleted.
Examples
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)
Remarks
The showUI, recycle, and onUserCancel parameters are not supported in applications that are not user interactive, such as Windows Services.
See also
Applies to
DeleteDirectory(String, DeleteDirectoryOption)
Deletes a directory.
public:
void DeleteDirectory(System::String ^ directory, Microsoft::VisualBasic::FileIO::DeleteDirectoryOption onDirectoryNotEmpty);public void DeleteDirectory (string directory, Microsoft.VisualBasic.FileIO.DeleteDirectoryOption onDirectoryNotEmpty);member this.DeleteDirectory : string * Microsoft.VisualBasic.FileIO.DeleteDirectoryOption -> unitPublic Sub DeleteDirectory (directory As String, onDirectoryNotEmpty As DeleteDirectoryOption)Parameters
- directory
- String
Directory to be deleted.
- onDirectoryNotEmpty
- DeleteDirectoryOption
Specifies what should be done when a directory that is to be deleted contains files or directories. Default is DeleteDirectoryOption.DeleteAllContents.
Exceptions
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 \\.\).
directory is Nothing or an empty string.
The directory does not exist or is a file.
A file in the directory or subdirectory is in use.
The directory name contains a colon (:).
The path exceeds the system-defined maximum length.
The user does not have required permissions.
The user cancels the operation or the directory cannot be deleted.
Examples
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)
