OPC Studio User's Guide and Reference
BrowsePathParser Constructor(BrowsePath,Int32)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Navigation.Parsing Namespace > BrowsePathParser Class > BrowsePathParser Constructor : BrowsePathParser Constructor(BrowsePath,Int32)
The base path for relative input paths. null if none given.

Because the OpcLabs.BaseLib.Navigation.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 BrowsePathFormatException.

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

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

Initializes a new instance of the class, optionally specifying the base path for relative input paths, and specifying maximum parent depth.
Syntax
'Declaration
 
Public Function New( _
   ByVal basePath As BrowsePath, _
   ByVal maximumParentDepth As Integer _
)
'Usage
 
Dim basePath As BrowsePath
Dim maximumParentDepth As Integer
 
Dim instance As New BrowsePathParser(basePath, maximumParentDepth)
public BrowsePathParser( 
   BrowsePath basePath,
   int maximumParentDepth
)
public:
BrowsePathParser( 
   BrowsePath^ basePath,
   int maximumParentDepth
)

Parameters

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

Because the OpcLabs.BaseLib.Navigation.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 BrowsePathFormatException.

The value of this parameter can 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).

Exceptions
ExceptionDescription

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.

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