BrowseNodes(IEasyAEClient,String,String,String,AEBrowseParameters) 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 areas. Uses computer name and server class for specifying the OPC server. A parent area name is passed in.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseNodes( _
   ByVal client As IEasyAEClient, _
   ByVal machineName As String, _
   ByVal serverClass As String, _
   ByVal parentQualifiedName As String, _
   ByVal browseParameters As AEBrowseParameters _
) As AENodeElementCollection

'Usage
 
Dim client As IEasyAEClient
Dim machineName As String
Dim serverClass As String
Dim parentQualifiedName As String
Dim browseParameters As AEBrowseParameters
Dim value As AENodeElementCollection
 
value = IEasyAEClientExtension.BrowseNodes(client, machineName, serverClass, parentQualifiedName, browseParameters)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public static AENodeElementCollection BrowseNodes( 
   IEasyAEClient client,
   string machineName,
   string serverClass,
   string parentQualifiedName,
   AEBrowseParameters browseParameters
)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public:
static AENodeElementCollection^ BrowseNodes( 
   IEasyAEClient^ client,
   String^ machineName,
   String^ serverClass,
   String^ parentQualifiedName,
   AEBrowseParameters^ browseParameters
)

Parameters

client: The client object that will perform the operation.
machineName: Name of the machine. Determines the computer on which the OPC server is located. May be an empty string, in which case the OPC server is assumed to exist on the local computer or at the computer specified for it by DCOM configuration.
serverClass: Contains ProgID of the OPC server.
parentQualifiedName: Fully qualified name of the parent area to be browsed (empty string for 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

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.