CommonPrefix Method (UABrowsePathElementCollection)

A UABrowsePathElementCollection object. The other browse path element collection.

Because the UABrowsePathElementCollection has an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedNameCollection (containing a sequence of qualified names, assumed to form a relative browse path using "any hierarchical" forward references) in place of this parameter, and the corresponding OPC UA browse path element collection will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromUAQualifiedNameCollection static method instead.

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).

Determines the longest common prefix of the current OPC-UA browse path element collection and a given OPC-UA browse path element collection.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<IteratorStateMachineAttribute(OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElementCollection/d__10)> 
<NotNullAttribute()> 
<PureAttribute()> 
Public Function CommonPrefix( _ 
   ByVal collection2 As UABrowsePathElementCollection _ 
) As IEnumerable(Of UABrowsePathElement)

'Usage
 
Dim instance As UABrowsePathElementCollection
Dim collection2 As UABrowsePathElementCollection
Dim value As IEnumerable(Of UABrowsePathElement)
 
value = instance.CommonPrefix(collection2)

[IteratorStateMachine(OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElementCollection/d__10)] 
[NotNull()] 
[Pure()] 
public IEnumerable<UABrowsePathElement> CommonPrefix( 
   UABrowsePathElementCollection collection2 
)

[IteratorStateMachine(OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElementCollection/d__10)] 
[NotNull()] 
[Pure()] 
public: 
IEnumerable<UABrowsePathElement^>^ CommonPrefix( 
   UABrowsePathElementCollection^ collection2 
)

Parameters

collection2

A UABrowsePathElementCollection object. The other browse path element collection.

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

The sequence of browse names that is the longest common prefix. An empty sequence if there is no common prefix.

This method never returns 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.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.

Remarks

This method is pure, i.e. it does not have observable side effects.

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

UABrowsePathElementCollection Class
UABrowsePathElementCollection 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.