BrowseTree(IUAReadOnlyPubSubConfiguration,UAPubSubConfigurationTreeNodeTypes) Method

Browses a tree of objects available in the OPC UA configuration, returning the node types specified.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BrowseTree( _
   ByVal readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration, _
   ByVal treeNodeTypes As UAPubSubConfigurationTreeNodeTypes _
) As ITreeTraversable(Of UAPubSubConfigurationNodeTreePosition)

'Usage
 
Dim readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration
Dim treeNodeTypes As UAPubSubConfigurationTreeNodeTypes
Dim value As ITreeTraversable(Of UAPubSubConfigurationNodeTreePosition)
 
value = IUAReadOnlyPubSubConfigurationExtension.BrowseTree(readOnlyPubSubConfiguration, treeNodeTypes)

[Extension()]
[NotNull()]
public static ITreeTraversable<UAPubSubConfigurationNodeTreePosition> BrowseTree( 
   IUAReadOnlyPubSubConfiguration readOnlyPubSubConfiguration,
   UAPubSubConfigurationTreeNodeTypes treeNodeTypes
)

[Extension()]
[NotNull()]
public:
static ITreeTraversable<UAPubSubConfigurationNodeTreePosition^>^ BrowseTree( 
   IUAReadOnlyPubSubConfiguration^ readOnlyPubSubConfiguration,
   UAPubSubConfigurationTreeNodeTypes treeNodeTypes
)

Parameters

readOnlyPubSubConfiguration: OPC UA PubSub configuration (read-only).
treeNodeTypes: The types of tree nodes to be returned.

Return Value

Returns a tree traversable for the objects in the configuration.

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.UA.OperationModel.UAException	The OPC UA 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.UA.OperationModel.UAException

The OPC UA 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

IUAReadOnlyPubSubConfigurationExtension Class
IUAReadOnlyPubSubConfigurationExtension Members
Overload List

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