FindRootAndPath Method

Finds a root directory of the specified OPC UA file or directory object, and a named node path from the root directory to the specified object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<CanBeNullAttribute()>
Public Shared Function FindRootAndPath( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal fileOrDirectoryNodeDescriptor As UANodeDescriptor _
) As UANamedNodeDescriptor

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim fileOrDirectoryNodeDescriptor As UANodeDescriptor
Dim value As UANamedNodeDescriptor
 
value = IEasyUAFileTransferExtension.FindRootAndPath(fileTransfer, endpointDescriptor, fileOrDirectoryNodeDescriptor)

[Extension()]
[CanBeNull()]
public static UANamedNodeDescriptor FindRootAndPath( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANodeDescriptor fileOrDirectoryNodeDescriptor
)

[Extension()]
[CanBeNull()]
public:
static UANamedNodeDescriptor^ FindRootAndPath( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANodeDescriptor^ fileOrDirectoryNodeDescriptor
)

Parameters

fileTransfer: The OPC UA file transfer object that will perform the operation.
endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.
fileOrDirectoryNodeDescriptor: The directory node descriptor of the file or directory for which the root and path should be found.

Return Value

If the root directory was found, returns a named node descriptor for the whose base node descriptor is the root directory. Returns null otherwise.

Exceptions

Exception Description

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.

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.

Remarks

In typical file systems, it is always possible to find a root. Also, in them, a root for the root is the root itself. In OPC UA file transfer, however, files can also appear standalone, and such files have no associated parent or root directory.

Requirements

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

Reference

IEasyUAFileTransferExtension Class
IEasyUAFileTransferExtension Members
FindRootDirectory Method
GetRootDirectory Method
IsRootDirectory Method

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.