BrowseNodes(IEasyAEClient,ServerDescriptor,AENodeDescriptor,String,AEBrowseFilter) Method

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

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseNodes( _
   ByVal client As IEasyAEClient, _
   ByVal serverDescriptor As ServerDescriptor, _
   ByVal parentNodeDescriptor As AENodeDescriptor, _
   ByVal vendorFilter As String, _
   ByVal browseFilter As AEBrowseFilter _
) As AENodeElementCollection

'Usage
 
Dim client As IEasyAEClient
Dim serverDescriptor As ServerDescriptor
Dim parentNodeDescriptor As AENodeDescriptor
Dim vendorFilter As String
Dim browseFilter As AEBrowseFilter
Dim value As AENodeElementCollection
 
value = IEasyAEClientExtension.BrowseNodes(client, serverDescriptor, parentNodeDescriptor, vendorFilter, browseFilter)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public static AENodeElementCollection BrowseNodes( 
   IEasyAEClient client,
   ServerDescriptor serverDescriptor,
   AENodeDescriptor parentNodeDescriptor,
   string vendorFilter,
   AEBrowseFilter browseFilter
)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public:
static AENodeElementCollection^ BrowseNodes( 
   IEasyAEClient^ client,
   ServerDescriptor^ serverDescriptor,
   AENodeDescriptor^ parentNodeDescriptor,
   String^ vendorFilter,
   AEBrowseFilter browseFilter
)

Parameters

client: The client object that will perform the operation.
serverDescriptor: The OPC server involved in the operation.
parentNodeDescriptor: Descriptor for the parent area to be browsed (can be the root).
vendorFilter: A server specific filter string (empty string for no filtering)
browseFilter: Which subset of browse elements (areas, sources, or both) to return.

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

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.
OpcLabs.EasyOpc.OperationModel.OpcException	The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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.

OpcLabs.EasyOpc.OperationModel.OpcException

The OPC "Classic" (or OPC XML-DA) operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

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

IEasyAEClientExtension Class
IEasyAEClientExtension Members
Overload List

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.