OPC Studio User's Guide and Reference
DeleteDirectoryIfExists Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.FileTransfer Namespace > IEasyUAFileTransferExtension Class : DeleteDirectoryIfExists Method
The OPC UA file transfer object that will perform the operation.
Endpoint descriptor. Identifies the OPC-UA server.
Node descriptor of the OPC UA directory.
A name of the OPC UA directory to delete.
Deletes an OPC UA directory if it exists (does nothing if the directory does not exist).
Syntax
'Declaration
 
<ExtensionAttribute()>
Public Shared Function DeleteDirectoryIfExists( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal directoryNodeDescriptor As UANodeDescriptor, _
   ByVal existingDirectoryName As String _
) As Boolean
'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim directoryNodeDescriptor As UANodeDescriptor
Dim existingDirectoryName As String
Dim value As Boolean
 
value = IEasyUAFileTransferExtension.DeleteDirectoryIfExists(fileTransfer, endpointDescriptor, directoryNodeDescriptor, existingDirectoryName)

Parameters

fileTransfer
The OPC UA file transfer object that will perform the operation.
endpointDescriptor
Endpoint descriptor. Identifies the OPC-UA server.
directoryNodeDescriptor
Node descriptor of the OPC UA directory.
existingDirectoryName
A name of the OPC UA directory to delete.

Return Value

Returns true if the directory existed and has been deleted; returns false if the directory does not exist.
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.

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

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

Recommendation: Whenever possible, do not use this method directly, and use a higher-level abstraction instead. See e.g. the GetWritableDirectoryContents(IEasyUAFileTransfer,UAEndpointDescriptor,UANamedNodePath) method, which allows you to obtain an object that can be used to manage directories, in a way that is generic and not tied to OPC UA specifics.

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