TryParse(BrowsePath,String,Int32,BrowsePath) Method

Attempts to parse a string containing a browse path, optionally given a base for relative paths. Maximum parent depth is also specified.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.PureAttribute()>
Public Overloads Shared Function TryParse( _
   ByVal basePath As BrowsePath, _
   ByVal value As String, _
   ByVal maximumParentDepth As Integer, _
   ByRef browsePath As BrowsePath _
) As IStringParsingError

'Usage
 
Dim basePath As BrowsePath
Dim value As String
Dim maximumParentDepth As Integer
Dim browsePath As BrowsePath
Dim value As IStringParsingError
 
value = BrowsePath.TryParse(basePath, value, maximumParentDepth, browsePath)

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.Pure()]
public static IStringParsingError TryParse( 
   BrowsePath basePath,
   string value,
   int maximumParentDepth,
   out BrowsePath browsePath
)

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.Pure()]
public:
static IStringParsingError^ TryParse( 
   BrowsePath^ basePath,
   String^ value,
   int maximumParentDepth,
   [Out] BrowsePath^ browsePath
)

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.

browsePath

If successful, the browse path object corresponding to the input string.

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

Return Value

Returns null if successful; otherwise, some OpcLabs.BaseLib.IStringParsingError indicating the reason of the failure.

This method can return null (Nothing in Visual Basic).

This return value of this method should not be ignored.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.
System.ArgumentOutOfRangeException	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.

System.ArgumentNullException

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.

System.ArgumentOutOfRangeException

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.

Remarks

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

Reference

BrowsePath Class
BrowsePath Members
Overload List

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.