TryParse Method (BrowsePathParser)

Attempts to parse a string containing an absolute browse path.

Syntax

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

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

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

'Usage
 
Dim instance As BrowsePathParser
Dim value As String
Dim browsePath As BrowsePath
Dim value As IStringParsingError
 
value = instance.TryParse(value, browsePath)

Parameters

value: The string containing the absolute browse path to be parsed.
The value of this parameter cannot be null (Nothing in Visual Basic).
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.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.

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

BrowsePathParser Class
BrowsePathParser Members

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.