TryCombine(UABrowsePathParsingFlags,String,String) Method

Attempts to combine the current OPC-UA browse path with a given browse path string, specifying the parsing flags.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
Public Overloads Function TryCombine( _
   ByVal parsingFlags As UABrowsePathParsingFlags, _
   ByVal more As String, _
   ByVal defaultNamespaceUriString As String _
) As IStringParsingError

'Usage
 
Dim instance As UABrowsePath
Dim parsingFlags As UABrowsePathParsingFlags
Dim more As String
Dim defaultNamespaceUriString As String
Dim value As IStringParsingError
 
value = instance.TryCombine(parsingFlags, more, defaultNamespaceUriString)

[CanBeNull()]
public IStringParsingError TryCombine( 
   UABrowsePathParsingFlags parsingFlags,
   string more,
   string defaultNamespaceUriString
)

[CanBeNull()]
public:
IStringParsingError^ TryCombine( 
   UABrowsePathParsingFlags parsingFlags,
   String^ more,
   String^ defaultNamespaceUriString
)

Parameters

parsingFlags

The parsing flags to be used.

more

The relative browse path string that the current browse path is to be combined with.

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

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.

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