Parses a string containing a browse path, optionally given a base for relative paths, and returns a corresponding browse path object.
Syntax
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public static BrowsePath Parse(
BrowsePath ,
string
)
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public:
static BrowsePath^ Parse(
BrowsePath^ ,
String^
)
'Declaration
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
<JetBrains.Annotations.PureAttribute()>
Public Overloads Shared Function Parse( _
ByVal As BrowsePath, _
ByVal As String _
) As BrowsePath
'Usage
Dim basePath As BrowsePath
Dim value As String
Dim value As BrowsePath
value = BrowsePath.Parse(basePath, value)
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).
Return Value
Returns the browse path object parsed from the input value.
This method never returns null
(Nothing
in Visual Basic).
This return value of this method should not be ignored.
Exceptions
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