CommonPrefix Method (BrowsePath)

Determines the longest common prefix of the current browse path and a given browse path.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<IteratorStateMachineAttribute(OpcLabs.BaseLib.Navigation.BrowsePath/d__37)> 
<NotNullAttribute()> 
<PureAttribute()> 
Public Function CommonPrefix( _ 
   ByVal path2 As BrowsePath _ 
) As IEnumerable(Of String)

'Usage
 
Dim instance As BrowsePath
Dim path2 As BrowsePath
Dim value As IEnumerable(Of String)
 
value = instance.CommonPrefix(path2)

[IteratorStateMachine(OpcLabs.BaseLib.Navigation.BrowsePath/d__37)] 
[NotNull()] 
[Pure()] 
public IEnumerable<string> CommonPrefix( 
   BrowsePath path2 
)

[IteratorStateMachine(OpcLabs.BaseLib.Navigation.BrowsePath/d__37)] 
[NotNull()] 
[Pure()] 
public: 
IEnumerable<String^>^ CommonPrefix( 
   BrowsePath^ path2 
)

Parameters

path2: The other browse path.

Return Value

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

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.

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

BrowsePath Class
BrowsePath Members

Send Documentation 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.