QuickOPC User's Guide and Reference
BrowseTree(IEasyAEClient,ServerDescriptor,AENodeDescriptor,AEBrowseParameters,Func<IEnumerable<AENodeElement>,IEnumerable<AENodeElement>>) Method



OpcLabs.EasyOpcClassicCore Assembly > OpcLabs.EasyOpc.AlarmsAndEvents.Extensions Namespace > IEasyAEClientExtension2 Class > BrowseTree Method : BrowseTree(IEasyAEClient,ServerDescriptor,AENodeDescriptor,AEBrowseParameters,Func<IEnumerable<AENodeElement>,IEnumerable<AENodeElement>>) Method
The client object that will perform the operation.
Server descriptor. Identifies the OPC-A&E server.
Starting node descriptor. Identifies the node in OPC server's address space.
Contains filtering conditions for OPC Alarms&Events node browsing.
Transforms a sequence of child node elements before it is used for further browsing.
Allows to traverse through OPC A&E address space nodes under the specified node, using given browse parameters, transforming the sequence of child node elements using a specified function.
Syntax
'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)

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

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

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