Moves or copies an OPC UA file to another directory, or renames a file.
Syntax
'Declaration
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function MoveOrCopyFile( _
ByVal As IEasyUAFileTransfer, _
ByVal As UAEndpointDescriptor, _
ByVal As UANodeDescriptor, _
ByVal As UANodeId, _
ByVal As UANodeId, _
ByVal As Boolean, _
ByVal As String _
) As UANodeId
'Usage
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim directoryNodeDescriptor As UANodeDescriptor
Dim existingFileNodeId As UANodeId
Dim newDirectoryNodeId As UANodeId
Dim copyObject As Boolean
Dim newName As String
Dim value As UANodeId
value = IEasyUAFileTransferExtension.MoveOrCopyFile(fileTransfer, endpointDescriptor, directoryNodeDescriptor, existingFileNodeId, newDirectoryNodeId, copyObject, newName)
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.
- existingFileNodeId
- The node Id of the file to move or copy.
- newDirectoryNodeId
- The node Id of the target directory of the move or copy operation.
- copyObject
- A flag indicating if a copy of the file should be created at the target directory.
- newName
- The new name of the file in the new location. If the string is empty, the name is unchanged.
Return Value
Returns the node Id of the moved or copied object. Even if the object is moved, the server may return a new node Id for it.
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. |
OpcLabs.EasyOpc.UA.OperationModel.UAException |
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. |
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