TryParse(UABrowsePathParsingFlags,UABrowsePath,String,String,UABrowsePath) Method

Attempts to parse a string containing a browse path using specified parsing flags, and optionally given a base for relative paths.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
<PureAttribute()>
Public Overloads Shared Function TryParse( _
   ByVal parsingFlags As UABrowsePathParsingFlags, _
   ByVal basePath As UABrowsePath, _
   ByVal value As String, _
   ByVal defaultNamespaceUriString As String, _
   ByRef browsePath As UABrowsePath _
) As IStringParsingError

'Usage
 
Dim parsingFlags As UABrowsePathParsingFlags
Dim basePath As UABrowsePath
Dim value As String
Dim defaultNamespaceUriString As String
Dim browsePath As UABrowsePath
Dim value As IStringParsingError
 
value = UABrowsePath.TryParse(parsingFlags, basePath, value, defaultNamespaceUriString, browsePath)

[CanBeNull()]
[Pure()]
public static IStringParsingError TryParse( 
   UABrowsePathParsingFlags parsingFlags,
   UABrowsePath basePath,
   string value,
   string defaultNamespaceUriString,
   out UABrowsePath browsePath
)

[CanBeNull()]
[Pure()]
public:
static IStringParsingError^ TryParse( 
   UABrowsePathParsingFlags parsingFlags,
   UABrowsePath^ basePath,
   String^ value,
   String^ defaultNamespaceUriString,
   [Out] UABrowsePath^ browsePath
)

Parameters

parsingFlags

The parsing flags to be used.

basePath

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

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

defaultNamespaceUriString

The namespace URI to be used with all elements that do not explicitly specify a namespace.

The value represents an OPC UA namespace URI string. Any string can be passed to this parameter (i.e. will not cause System.ArgumentException), but not all values make sense and will work when an operation using them is attempted.

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

browsePath

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

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

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.ComponentModel.InvalidEnumArgumentException	An invalid enumeration value was used. 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.ComponentModel.InvalidEnumArgumentException

An invalid enumeration value was used.

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

UABrowsePath Class
UABrowsePath Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support