IsPrefix Method (BrowsePath)

Determines whether a given browse path is a prefix of the current browse path.

Syntax

Visual Basic
C#
C++/CLI

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

Return Value

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

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. Technical support: Online Forums, FAQ.