'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function Rename( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal directoryNodeDescriptor As UANodeId, _
   ByVal existingFileOrDirectoryNodeId As UANodeId, _
   ByVal newName As String _
) As UANodeId

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim directoryNodeDescriptor As UANodeId
Dim existingFileOrDirectoryNodeId As UANodeId
Dim newName As String
Dim value As UANodeId
 
value = IEasyUAFileTransferExtension.Rename(fileTransfer, endpointDescriptor, directoryNodeDescriptor, existingFileOrDirectoryNodeId, newName)

[Extension()]
[NotNull()]
public static UANodeId Rename( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANodeId directoryNodeDescriptor,
   UANodeId existingFileOrDirectoryNodeId,
   string newName
)

[Extension()]
[NotNull()]
public:
static UANodeId^ Rename( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANodeId^ directoryNodeDescriptor,
   UANodeId^ existingFileOrDirectoryNodeId,
   String^ 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.

existingFileOrDirectoryNodeId

The node descriptor of the file or directory to rename.

newName

The new name of the file or directory in the new location. If the string is empty, the name is unchanged.

Return Value

This method internally uses 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.

The existingFileOrDirectoryNodeId must be an existing node in the server, of object type OpcLabs.EasyOpc.UA.AddressSpace.Standard.UAObjectTypeIds.FileType or 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).

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