BrowseTree(IEasyUAClient,UAEndpointDescriptor) Method

Allows to traverse through OPC UA address space data nodes under the ObjectsFolder node.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseTree( _
   ByVal client As IEasyUAClient, _
   ByVal endpointDescriptor As UAEndpointDescriptor _
) As ITreeTraversable(Of UANodeTreePosition)

'Usage
 
Dim client As IEasyUAClient
Dim endpointDescriptor As UAEndpointDescriptor
Dim value As ITreeTraversable(Of UANodeTreePosition)
 
value = IEasyUAClientExtension2.BrowseTree(client, endpointDescriptor)

[Extension()]
[NotNull()]
public static ITreeTraversable<UANodeTreePosition> BrowseTree( 
   IEasyUAClient client,
   UAEndpointDescriptor endpointDescriptor
)

[Extension()]
[NotNull()]
public:
static ITreeTraversable<UANodeTreePosition^>^ BrowseTree( 
   IEasyUAClient^ client,
   UAEndpointDescriptor^ endpointDescriptor
)

Parameters

client: The client object that will perform the operation.
endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.

Return Value

Returns an enumerator of tree positions that will traverse through all nodes specified.

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.

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.

Remarks

If you want to enumerate through a sequence of the tree nodes, convert the result to a sequence using the OpcLabs.BaseLib.Graphs.Extensions.ITreeTraversableExtension.ToEnumerable<T> method.

The method automatically prevents recursion into nodes that have already been traversed.

The root position in a tree will correspond to the ObjectsFolder node. The OpcLabs.EasyOpc.UA.Graphs.UANodeTreePosition object for the root is special one, in that from its OpcLabs.EasyOpc.UA.AddressSpace.UANodeElement properties, only its NodeId is filled in.

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

IEasyUAClientExtension2 Class
IEasyUAClientExtension2 Members
Overload List

Send Documentation Feedback. Technical Support