OPC Studio User's Guide and Reference
IsPrefix Method (BrowsePath)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation Namespace > BrowsePath Class : IsPrefix Method
The browse path to be tested as a prefix.

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

Determines whether a given browse path is a prefix of the current browse path.
Syntax
'Declaration
 
<PureAttribute()>
Public Function IsPrefix( _
   ByVal prefix As BrowsePath _
) As Boolean
'Usage
 
Dim instance As BrowsePath
Dim prefix As BrowsePath
Dim value As Boolean
 
value = instance.IsPrefix(prefix)
[Pure()]
public bool IsPrefix( 
   BrowsePath prefix
)
[Pure()]
public:
bool IsPrefix( 
   BrowsePath^ prefix
) 

Parameters

prefix
The browse path to be tested as a prefix.

Because the 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

True if the given browse path is a prefix of the current browse path; false otherwise.
Exceptions
ExceptionDescription

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

See Also