'Declaration
<ExtensionAttribute()> <NotNullAttribute()> Public Overloads Shared Function MoveOrCopy( _ ByVal fileTransfer As IEasyUAFileTransfer, _ ByVal endpointDescriptor As UAEndpointDescriptor, _ ByVal existingFileOrDirectoryNamedNodeDescriptor As UANamedNodeDescriptor, _ ByVal newDirectoryNamedNodePath As UANamedNodePath, _ ByVal copyObject As Boolean, _ ByVal newName As String _ ) As UANodeId
'Usage
Dim fileTransfer As IEasyUAFileTransfer Dim endpointDescriptor As UAEndpointDescriptor Dim existingFileOrDirectoryNamedNodeDescriptor As UANamedNodeDescriptor Dim newDirectoryNamedNodePath As UANamedNodePath Dim copyObject As Boolean Dim newName As String Dim value As UANodeId value = IEasyUAFileTransferExtension.MoveOrCopy(fileTransfer, endpointDescriptor, existingFileOrDirectoryNamedNodeDescriptor, newDirectoryNamedNodePath, copyObject, newName)
[Extension()] [NotNull()] public static UANodeId MoveOrCopy( IEasyUAFileTransfer fileTransfer, UAEndpointDescriptor endpointDescriptor, UANamedNodeDescriptor existingFileOrDirectoryNamedNodeDescriptor, UANamedNodePath newDirectoryNamedNodePath, bool copyObject, string newName )
[Extension()] [NotNull()] public: static UANodeId^ MoveOrCopy( IEasyUAFileTransfer^ fileTransfer, UAEndpointDescriptor^ endpointDescriptor, UANamedNodeDescriptor^ existingFileOrDirectoryNamedNodeDescriptor, UANamedNodePath^ newDirectoryNamedNodePath, bool copyObject, String^ newName )
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). - existingFileOrDirectoryNamedNodeDescriptor
- The named node descriptor of the file or directory to move or copy.
Because the OpcLabs.EasyOpc.UA.Navigation.UANamedNodeDescriptor 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 final node descriptor) in place of this parameter, and the corresponding OPC UA named node 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.Navigation.UANamedNodeDescriptor.FromUANodeDescriptor static method instead.
The value of this parameter cannot be
null
(Nothing
in Visual Basic). - newDirectoryNamedNodePath
- The named node path of the target directory of the move or copy operation.
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). - copyObject
- A flag indicating if a copy of the file or directory should be created at the target directory.
- newName
- The new name of the file or directory in the new location. If the string is empty, the name is unchanged.
The value of this parameter cannot be
null
(Nothing
in Visual Basic).
Return Value
Because there is an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UANodeId to OpcLabs.EasyOpc.UA.UANodeDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UANodeId in any place where the OpcLabs.EasyOpc.UA.UANodeDescriptor is expected as input, and the corresponding node descriptor will be constructed automatically.
Also, because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion to System.String, and it converts to the expanded text of the node Id (OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.ExpandedText), in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UANodeId in any place where expanded text of a node Id (a string) is expected as input, and the corresponding expanded text will be taken automatically from the node Id.
This method never returns null
(Nothing
in Visual Basic).