CommonPrefix Method (

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

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function CommonPrefix( _
   ByVal path2 As Object _
) As StringCollection

'Usage
 
Dim instance As _BrowsePath
Dim path2 As Object
Dim value As StringCollection
 
value = instance.CommonPrefix(path2)

[NotNull()]
StringCollection CommonPrefix( 
   object path2
)

[NotNull()]
StringCollection^ CommonPrefix( 
   Object^ path2
)

Parameters

path2

The other browse path.

Because the OpcLabs.BaseLib.Navigation.BrowsePath has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (containing an absolute browse path to be parsed) in place of this parameter, and the corresponding browse path object will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString static method instead. CAUTION: Parsing the browse path can throw OpcLabs.BaseLib.Navigation.Parsing.BrowsePathFormatException.

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

Return Value

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

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

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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 Interface
_BrowsePath 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.