'Declaration
 
Sub Delete( _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal directoryNodeDescriptor As UANodeDescriptor, _
   ByVal existingFileOrDirectoryNodeId As UANodeId _
) 

'Usage
 
Dim instance As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim directoryNodeDescriptor As UANodeDescriptor
Dim existingFileOrDirectoryNodeId As UANodeId
 
instance.Delete(endpointDescriptor, directoryNodeDescriptor, existingFileOrDirectoryNodeId)

void Delete( 
   UAEndpointDescriptor endpointDescriptor,
   UANodeDescriptor directoryNodeDescriptor,
   UANodeId existingFileOrDirectoryNodeId
)

void Delete( 
   UAEndpointDescriptor^ endpointDescriptor,
   UANodeDescriptor^ directoryNodeDescriptor,
   UANodeId^ existingFileOrDirectoryNodeId
) 

Parameters

endpointDescriptor

Endpoint descriptor. Identifies the OPC-UA server.

directoryNodeDescriptor

Node descriptor of the OPC UA directory.

existingFileOrDirectoryNodeId

A node descriptor of the file or directory to delete.

This method corresponds to (but is not fully identical with) the OPC UA File Transfer Method .

The directoryNodeDescriptor must be an existing node in the server, of object type OpcLabs.EasyOpc.UA.AddressSpace.Standard.UAObjectTypeIds.FileDirectoryType.

For existingFileOrDirectoryNodeId, "In the case of a directory, all file and directory Objects below the directory to delete are deleted recursively."

This method will delete either a file or directory, as long as the existingFileOrDirectoryNodeId refers to an OPC UA file or directory object. If you want to delete a file and be sure that you do not delete a directory, use the IEasyUAFileTransferExtension.DeleteFile extension method or one of its other overloads. If you want to delete a directory and be sure that you do not delete a file, use the IEasyUAFileTransferExtension.DeleteDirectory extension method or one of its other overloads.

This method will throw an exception if the object you are trying to delete does not exist. If you want to assure object deletion and do nothing if the object does not exist, you one of the following extension methods:

• IEasyUAFileTransferExtension.DeleteIfExists
• IEasyUAFileTransferExtension.DeleteFileIfExists
• IEasyUAFileTransferExtension.DeleteDirectoryIfExists

Recommendation: Whenever possible, do not use this method directly, and use a higher-level abstraction instead. You can obtain a writable file provider (using IEasyUAFileTransferExtension.GetWritableFileProvider). For directories, you can obtain writable directory contents (using OpcLabs.BaseLib.Extensions.FileProviders.IWritableDirectory.GetWritableDirectoryContents), and then call the OpcLabs.BaseLib.Extensions.FileProviders.IWritableDirectoryContents.Delete method to delete the directory. For files, you can obtain writable file info (using OpcLabs.BaseLib.Extensions.FileProviders.IWritableDirectory.GetWritableFileInfo) and then call the OpcLabs.BaseLib.Extensions.FileProviders.IWritableFileInfo.Delete method to delete the file.

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