'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function MoveFile( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal directoryNamedNodePath As UANamedNodePath, _
   ByVal existingFileName As String, _
   ByVal newDirectoryNodeId As UANodeId _
) As UANodeId

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim directoryNamedNodePath As UANamedNodePath
Dim existingFileName As String
Dim newDirectoryNodeId As UANodeId
Dim value As UANodeId
 
value = IEasyUAFileTransferExtension.MoveFile(fileTransfer, endpointDescriptor, directoryNamedNodePath, existingFileName, newDirectoryNodeId)

[Extension()]
[NotNull()]
public static UANodeId MoveFile( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANamedNodePath directoryNamedNodePath,
   string existingFileName,
   UANodeId newDirectoryNodeId
)

[Extension()]
[NotNull()]
public:
static UANodeId^ MoveFile( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANamedNodePath^ directoryNamedNodePath,
   String^ existingFileName,
   UANodeId^ newDirectoryNodeId
) 

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).

existingFileName

A name of an existing OPC UA file.

The value of this parameter cannot be null (Nothing in Visual Basic).

newDirectoryNodeId

The node Id of the target directory of the move operation.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the nodeId) in place of this parameter, and the corresponding OPC UA node Id will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId.UANodeId Constructor(String) constructor instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

This method internally uses the OPC UA File Transfer Method .

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

Recommendation: Whenever possible, do not use this method directly, and use a higher-level abstraction instead. You can obtain a writable file provider (using GetWritableFileProvider), and make use of its methods, and methods available on the writable directory contents (obtained using OpcLabs.BaseLib.Extensions.FileProviders.IWritableDirectory.GetWritableDirectoryContents) or writable file info (obtained using OpcLabs.BaseLib.Extensions.FileProviders.IWritableDirectory.GetWritableFileInfo).

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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