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



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation Namespace > BrowsePath Class > Parse Method : Parse(BrowsePath,String,Int32) Method
The base path for relative input paths. null if none given.
The string containing the browse path to be parsed.
How many levels above the base path can be referenced.
Parses a string containing a browse path, optionally given a base for relative paths, and returns a corresponding browse path object. Maximum parent depth is also specified.
Syntax
'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.
value
The string containing the browse path to be parsed.
maximumParentDepth
How many levels above the base path can be referenced.

Return Value

Returns the browse path object parsed from the input value.
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 value of an argument is outside the allowable range of values as defined by the invoked method.

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