QuickOPC User's Guide and Reference
TraverseNodeTree(IEasyUAClient,UAEndpointDescriptor,UANodeDescriptor,UABrowseParameters) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Extensions Namespace > IEasyUAClientExtension2 Class > TraverseNodeTree Method : TraverseNodeTree(IEasyUAClient,UAEndpointDescriptor,UANodeDescriptor,UABrowseParameters) Method
The client object that will perform the operation.
Endpoint descriptor. Identifies the OPC-UA server.
Node descriptor. Identifies the node in OPC server's address space.
Browse parameters such as node classes and reference types to be returned.
Allows to traverse through address space nodes under the specified node, using given browse parameters.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function TraverseNodeTree( _
   ByVal client As IEasyUAClient, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal nodeDescriptor As UANodeDescriptor, _
   ByVal browseParameters As UABrowseParameters _
) As IEnumerable(Of UATreePosition)
'Usage
 
Dim client As IEasyUAClient
Dim endpointDescriptor As UAEndpointDescriptor
Dim nodeDescriptor As UANodeDescriptor
Dim browseParameters As UABrowseParameters
Dim value As IEnumerable(Of UATreePosition)
 
value = IEasyUAClientExtension2.TraverseNodeTree(client, endpointDescriptor, nodeDescriptor, browseParameters)

Parameters

client
The client object that will perform the operation.
endpointDescriptor
Endpoint descriptor. Identifies the OPC-UA server.
nodeDescriptor
Node descriptor. Identifies the node in OPC server's address space.
browseParameters
Browse parameters such as node classes and reference types to be returned.

Return Value

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

Performs a breadth-first traversal.

The root position in a tree will correspond to the specified starting node. The OpcLabs.EasyOpc.UA.Graphs.UATreePosition object for the root is special one, in that from its OpcLabs.EasyOpc.UA.AddressSpace.UANodeElement properties, only its NodeId is filled in.

You can obtain nodeDescriptor e.g. by calling one of the browsing methods on OpcLabs.EasyOpc.UA.EasyUAClient object.

Requirements

Target Platforms: .NET Framework: Windows 7 with SP1, Windows Server 2012; .NET Core: Linux, Microsoft Windows

See Also

Reference

IEasyUAClientExtension2 Class
IEasyUAClientExtension2 Members
Overload List