OPC Studio User's Guide and Reference
Parse(BrowsePath,String) Method



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation Namespace > BrowsePath Class > Parse Method : Parse(BrowsePath,String) Method
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).

The string containing the browse path to be parsed.

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

Parses a string containing a browse path, optionally given a base for relative paths, and returns a corresponding browse path object.
Syntax
'Declaration
 
<NotNullAttribute()>
<PureAttribute()>
Public Overloads Shared Function Parse( _
   ByVal basePath As BrowsePath, _
   ByVal value As String _
) As BrowsePath
'Usage
 
Dim basePath As BrowsePath
Dim value As String
Dim value As BrowsePath
 
value = BrowsePath.Parse(basePath, value)
[NotNull()]
[Pure()]
public static BrowsePath Parse( 
   BrowsePath basePath,
   string value
)
[NotNull()]
[Pure()]
public:
static BrowsePath^ Parse( 
   BrowsePath^ basePath,
   String^ 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).

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.

The browse path cannot be parsed.
Remarks

If no base path is given, the input browse path must be absolute.

No levels above the base path can be referenced. If you want to allow this, use an overload with maximumParentDepth argument.

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