'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseTree( _
   ByVal client As IEasyAEClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal nodeDescriptor As AENodeDescriptor, _
   ByVal browseParameters As AEBrowseParameters, _
   ByVal nodeElementsTransformer As Func(Of IEnumerable(Of AENodeElement),IEnumerable(Of AENodeElement)) _
) As ITreeTraversable(Of AENodeTreePosition)

'Usage
 
Dim client As IEasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim nodeDescriptor As AENodeDescriptor
Dim browseParameters As AEBrowseParameters
Dim nodeElementsTransformer As Func(Of IEnumerable(Of AENodeElement),IEnumerable(Of AENodeElement))
Dim value As ITreeTraversable(Of AENodeTreePosition)
 
value = IEasyAEClientExtension2.BrowseTree(client, serverDescriptor, nodeDescriptor, browseParameters, nodeElementsTransformer)

[Extension()]
[NotNull()]
public static ITreeTraversable<AENodeTreePosition> BrowseTree( 
   IEasyAEClient client,
   ServerDescriptor serverDescriptor,
   AENodeDescriptor nodeDescriptor,
   AEBrowseParameters browseParameters,
   Func<IEnumerable<AENodeElement>,IEnumerable<AENodeElement>> nodeElementsTransformer
)

[Extension()]
[NotNull()]
public:
static ITreeTraversable<AENodeTreePosition^>^ BrowseTree( 
   IEasyAEClient^ client,
   ServerDescriptor^ serverDescriptor,
   AENodeDescriptor^ nodeDescriptor,
   AEBrowseParameters^ browseParameters,
   Func<IEnumerable<AENodeElement^>^,IEnumerable<AENodeElement^>^>^ nodeElementsTransformer
) 

Parameters

client

The client object that will perform the operation.

serverDescriptor

Server descriptor. Identifies the OPC-A&E server.

nodeDescriptor

Starting node descriptor. Identifies the node in OPC server's address space.

browseParameters

Contains filtering conditions for OPC Alarms&Events node browsing.

nodeElementsTransformer

Transforms a sequence of child node elements before it is used for further browsing.

Return Value

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.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.

You can obtain nodeDescriptor e.g. by calling one of the browsing methods on OpcLabs.EasyOpc.AlarmsAndEvents.IEasyAEClient interface.

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