Parse(String) Method

Parses a string containing an absolute browse path, and returns a corresponding browse path object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
<JetBrains.Annotations.PureAttribute()>
Public Overloads Shared Function Parse( _
   ByVal value As String _
) As BrowsePath

'Usage
 
Dim value As String
Dim value As BrowsePath
 
value = BrowsePath.Parse(value)

[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public static BrowsePath Parse( 
   string value
)

[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
[JetBrains.Annotations.Pure()]
public:
static BrowsePath^ Parse( 
   String^ value
)

Parameters

value: The string containing the absolute 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

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.
OpcLabs.BaseLib.Navigation.Parsing.BrowsePathFormatException	The browse path cannot be parsed.

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.

OpcLabs.BaseLib.Navigation.Parsing.BrowsePathFormatException The browse path cannot be parsed.

Remarks

The input browse path must be absolute.

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.