BrowseTree(IEasyAEClient,ServerDescriptor) Method

Allows to traverse through OPC A&E address space nodes under the root.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseTree( _
   ByVal client As IEasyAEClient, _
   ByVal serverDescriptor As ServerDescriptor _
) As ITreeTraversable(Of AENodeTreePosition)

'Usage
 
Dim client As IEasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim value As ITreeTraversable(Of AENodeTreePosition)
 
value = IEasyAEClientExtension2.BrowseTree(client, serverDescriptor)

[Extension()]
[NotNull()]
public static ITreeTraversable<AENodeTreePosition> BrowseTree( 
   IEasyAEClient client,
   ServerDescriptor serverDescriptor
)

[Extension()]
[NotNull()]
public:
static ITreeTraversable<AENodeTreePosition^>^ BrowseTree( 
   IEasyAEClient^ client,
   ServerDescriptor^ serverDescriptor
)

Parameters

client: The client object that will perform the operation.
serverDescriptor: Server descriptor. Identifies the OPC-A&E server.

Return Value

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

Exceptions

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.

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.AlarmsAndEvents.Graphs.AENodeTreePosition object for the root is special one, in that from its OpcLabs.EasyOpc.AlarmsAndEvents.AddressSpace.AENodeElement properties, only its QualifiedName is filled in.

Requirements

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

Reference

IEasyAEClientExtension2 Class
IEasyAEClientExtension2 Members
Overload List