OPC Studio User's Guide and Reference
Delete Method (IWritableDirectoryContentsExtension)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Extensions.FileProviders Namespace > IWritableDirectoryContentsExtension Class : Delete Method
The writable directory contents object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Deletes a directory and its contents from a path.
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Sub Delete( _
   ByVal writableDirectoryContents As IWritableDirectoryContents _
) 
'Usage
 
Dim writableDirectoryContents As IWritableDirectoryContents
 
IWritableDirectoryContentsExtension.Delete(writableDirectoryContents)

Parameters

writableDirectoryContents
The writable directory contents object that will perform the operation.

The value of this parameter cannot be null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

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.

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.

An invoked method is not supported at all, or is not supported with the parameters used to create the object.

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.

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

This method is similar to , but is generalized for a file provider model and thus an abstract file system.

Attempting to delete a directory that is not empty throws an System.IO.IOException.

This method is equivalent to calling the IWritableDirectoryContents.Delete with the 'recursive' parameter set to false. Use the IWritableDirectoryContents.Delete with the 'recursive' parameter set to true if you want to delete this directory, its subdirectories, and all files.

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

See Also