BrowseNodes Method (EasyAEClient)

Browses the specified area (or root) in OPC server's process area space, and returns information about child nodes (areas or sources) found. Uses server descriptor for specifying the OPC server. A parent area descriptor is passed in. No vendor-specific filtering.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function BrowseNodes( _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal parentNodeDescriptor As AENodeDescriptor, _
   ByVal browseParameters As AEBrowseParameters _
) As AENodeElementCollection

'Usage
 
Dim instance As EasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim parentNodeDescriptor As AENodeDescriptor
Dim browseParameters As AEBrowseParameters
Dim value As AENodeElementCollection
 
value = instance.BrowseNodes(serverDescriptor, parentNodeDescriptor, browseParameters)

public AENodeElementCollection BrowseNodes( 
   ServerDescriptor serverDescriptor,
   AENodeDescriptor parentNodeDescriptor,
   AEBrowseParameters browseParameters
)

public:
AENodeElementCollection^ BrowseNodes( 
   ServerDescriptor^ serverDescriptor,
   AENodeDescriptor^ parentNodeDescriptor,
   AEBrowseParameters^ browseParameters
)

Parameters

serverDescriptor: The OPC server involved in the operation.
parentNodeDescriptor: Descriptor for the parent area to be browsed (can be the root).
browseParameters: Contains filtering conditions.

Return Value

The method returns a keyed collection of OpcLabs.EasyOpc.AlarmsAndEvents.AddressSpace.AENodeElement values, each containing information about a particular node (area or source) found. The keys of the keyed collection are the names of the nodes.

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.
OpcLabs.EasyOpc.OperationModel.OpcException	The OPC "Classic" (or OPC XML-DA) operation has failed.

Requirements

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

Reference

EasyAEClient Class
EasyAEClient Members

Send Feedback