'Declaration
<ExtensionAttribute()> Public Overloads Shared Function DeleteIfExists( _ ByVal fileTransfer As IEasyUAFileTransfer, _ ByVal endpointDescriptor As UAEndpointDescriptor, _ ByVal directoryNamedNodePath As UANamedNodePath, _ ByVal existingFileOrDirectoryName As String _ ) As Boolean
'Usage
Dim fileTransfer As IEasyUAFileTransfer Dim endpointDescriptor As UAEndpointDescriptor Dim directoryNamedNodePath As UANamedNodePath Dim existingFileOrDirectoryName As String Dim value As Boolean value = IEasyUAFileTransferExtension.DeleteIfExists(fileTransfer, endpointDescriptor, directoryNamedNodePath, existingFileOrDirectoryName)
[Extension()] public static bool DeleteIfExists( IEasyUAFileTransfer fileTransfer, UAEndpointDescriptor endpointDescriptor, UANamedNodePath directoryNamedNodePath, string existingFileOrDirectoryName )
[Extension()] public: static bool DeleteIfExists( IEasyUAFileTransfer^ fileTransfer, UAEndpointDescriptor^ endpointDescriptor, UANamedNodePath^ directoryNamedNodePath, String^ existingFileOrDirectoryName )
Parameters
- fileTransfer
- The OPC UA file transfer object that will perform the operation.
This is typically the EasyUAFileTransferClient object.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - endpointDescriptor
- Endpoint descriptor. Identifies the OPC-UA server.
Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromUri static method instead.
Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to OpcLabs.EasyOpc.UA.UAEndpointDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement (results from OPC UA discovery) in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a (non-null) OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement to OpcLabs.EasyOpc.UA.UAEndpointDescriptor using the ToUAEndpointDescriptor or ToUAEndpointDescriptor method instead.
If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - directoryNamedNodePath
- A named node path of the OPC UA directory.
Because the OpcLabs.EasyOpc.UA.Navigation.UANamedNodePath has an implicit conversion from OpcLabs.EasyOpc.UA.UANodeDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.UANodeDescriptor (containing the base and only node in the named node path) in place of this parameter, and the corresponding OPC UA named node path will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.Navigation.UANamedNodePath.FromUANodeDescriptor static method instead.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - existingFileOrDirectoryName
- A name of the OPC UA file or directory to delete.
The value of this parameter cannot be
null
(Nothing
in Visual Basic).
Return Value
true
if the file or directory existed and has been deleted; returns false
if the file or directory does not exist.