BrowseMultiple Method (IEasyUAClient)

Browses multiples nodes in server's address space. Starts from the specified nodes, and returns information about child nodes found.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.ItemNotNullAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Function BrowseMultiple( _
   ByVal browseArgumentsArray() As UABrowseArguments _
) As UANodeElementCollectionResult()

'Usage
 
Dim instance As IEasyUAClient
Dim browseArgumentsArray() As UABrowseArguments
Dim value() As UANodeElementCollectionResult
 
value = instance.BrowseMultiple(browseArgumentsArray)

[JetBrains.Annotations.ItemNotNull()]
[JetBrains.Annotations.NotNull()]
UANodeElementCollectionResult[] BrowseMultiple( 
   UABrowseArguments[] browseArgumentsArray
)

[JetBrains.Annotations.ItemNotNull()]
[JetBrains.Annotations.NotNull()]
array<UANodeElementCollectionResult^>^ BrowseMultiple( 
   array<UABrowseArguments^>^ browseArgumentsArray
)

Parameters

browseArgumentsArray

Array of OpcLabs.EasyOpc.UA.OperationModel.UABrowseArguments. Specifies which nodes to browse in an OPC-UA server, and the browse parameters to be used.

The value of this parameter cannot be null (Nothing in Visual Basic).

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

Return Value

Array of OpcLabs.EasyOpc.UA.OperationModel.UANodeElementCollectionResult. Returns an array of results. Each result, when successful, stores the node element collection that is the outcome of the browse. The indices of elements in the output array are the same as those in the input array, .

This method never returns null (Nothing in Visual Basic).

The individual elements of the returned value are never null (Nothing in Visual Basic).

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.
System.ObjectDisposedException	An operation was performed on a disposed object.

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.

System.ObjectDisposedException An operation was performed on a disposed object.

Remarks

Each element in the input array corresponds to a separate logical browse operation (although the operations may and will be executed together, if possible). The method returns an array of results, where each result corresponds to the browse operation at the same index in the input array.

This is a multiple-operation method. In a properly written program, it does not throw any exceptions. You should therefore not put try/catch statements or similar constructs around calls to this method. The only exceptions thrown by this method are for usage errors, i.e. when your code violates the usage contract of the method, such as passing in invalid arguments or calling the method when the state of the object does not allow it. Any operation-related errors (i.e. errors that depend on external conditions that your code cannot reliably check) are indicated in the result objects returned by the method. For more information, see Multiple-operation Methods and Do not catch any exceptions with asynchronous or multiple-operation methods.

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

IEasyUAClient Interface
IEasyUAClient Members

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.