DeleteSubdirectory(IWritableDirectoryContents,String,Boolean) Method

Deletes a subdirectory, specifying whether its subdirectories should be recursively deleted too.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub DeleteSubdirectory( _
   ByVal writableDirectoryContents As IWritableDirectoryContents, _
   ByVal path As String, _
   ByVal recursive As Boolean _
)

'Usage
 
Dim writableDirectoryContents As IWritableDirectoryContents
Dim path As String
Dim recursive As Boolean
 
IWritableDirectoryContentsExtension.DeleteSubdirectory(writableDirectoryContents, path, recursive)

[Extension()]
public static void DeleteSubdirectory( 
   IWritableDirectoryContents writableDirectoryContents,
   string path,
   bool recursive
)

[Extension()]
public:
static void DeleteSubdirectory( 
   IWritableDirectoryContents^ writableDirectoryContents,
   String^ path,
   bool recursive
)

Parameters

writableDirectoryContents: The writable directory contents object that will perform the operation.
The value of this parameter cannot be null (Nothing in Visual Basic).
path: Relative path that identifies the directory.
The value of this parameter cannot be null (Nothing in Visual Basic).
recursive: true to delete the specified subdirectory, its subdirectories, and all files; false to delete just the specified subdirectory directory.

Exceptions

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
System.IO.DirectoryNotFoundException	Part of a file or directory cannot be found. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.IO.IOException	An I/O error has occurred. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.NotSupportedException	An invoked method is not supported at all, or is not supported with the parameters used to create the object.
System.Security.SecurityException	A security error was detected. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.
System.UnauthorizedAccessException	The operating system has denied access because of an I/O error or a specific type of security error. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

For Microsoft.Extensions.FileProviders.IDirectoryContents, IDirectory2, IDirectoryContents2, IWritableDirectory and IWritableDirectoryContents, relative paths are based on the directory itself; absolute paths are based on the root directory of the file provider. Notice the difference from Microsoft.Extensions.FileProviders.IFileInfo, IFileInfo2 and IWritableFileInfo, where relative paths are based on the directory where the file is located.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IWritableDirectoryContentsExtension Class
IWritableDirectoryContentsExtension Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support