BrowseTree(IEasyAEClient,AEBrowseArguments) Method

Allows to traverse through OPC A&E address space nodes under the specified node, using given browse arguments.

Syntax

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

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

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

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

Parameters

client

The client object that will perform the operation.

This is typically the OpcLabs.EasyOpc.AlarmsAndEvents.EasyAEClient object.

The value of this parameter cannot be null (Nothing in Visual Basic).

browseArguments

Holds arguments needed to browse OPC A&E server nodes.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

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

This method never returns null (Nothing in Visual Basic).

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

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

IEasyAEClientExtension2 Class
IEasyAEClientExtension2 Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support