OPC Studio User's Guide and Reference
BrowseTree(IEasyUAClient,UABrowseArguments) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Extensions Namespace > IEasyUAClientExtension2 Class > BrowseTree Method : BrowseTree(IEasyUAClient,UABrowseArguments) Method
The client object that will perform the operation.
Holds arguments needed to browse OPC UA server nodes.
Allows to traverse through OPC UA address space nodes under the specified node, using given browse arguments.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseTree( _
   ByVal client As IEasyUAClient, _
   ByVal browseArguments As UABrowseArguments _
) As ITreeTraversable(Of UANodeTreePosition)
'Usage
 
Dim client As IEasyUAClient
Dim browseArguments As UABrowseArguments
Dim value As ITreeTraversable(Of UANodeTreePosition)
 
value = IEasyUAClientExtension2.BrowseTree(client, browseArguments)

Parameters

client
The client object that will perform the operation.
browseArguments
Holds arguments needed to browse OPC UA server nodes.

Return Value

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

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 specified starting 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

See Also