'Declaration
 
<NotNullAttribute()>
<PureAttribute()>
Public Overloads Shared Function Parse( _
   ByVal basePath As BrowsePath, _
   ByVal value As String, _
   ByVal maximumParentDepth As Integer _
) As BrowsePath

'Usage
 
Dim basePath As BrowsePath
Dim value As String
Dim maximumParentDepth As Integer
Dim value As BrowsePath
 
value = BrowsePath.Parse(basePath, value, maximumParentDepth)

[NotNull()]
[Pure()]
public static BrowsePath Parse( 
   BrowsePath basePath,
   string value,
   int maximumParentDepth
)

[NotNull()]
[Pure()]
public:
static BrowsePath^ Parse( 
   BrowsePath^ basePath,
   String^ value,
   int maximumParentDepth
) 

Parameters

basePath

The base path for relative input paths. null if none given.

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 can be null (Nothing in Visual Basic).

value

The string containing the browse path to be parsed.

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

maximumParentDepth

How many levels above the base path can be referenced.

Valid values of this parameter are in the range from 0 to 2147483647 (Int32.MaxValue).

Return Value

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

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows