Parse(IUANodeIdParser,String,Boolean) Method

Parse an OPC-UA node Id. Specify whether namespace is required.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function Parse( _
   ByVal nodeIdParser As IUANodeIdParser, _
   ByVal s As String, _
   ByVal requireNamespace As Boolean _
) As UANodeId

'Usage
 
Dim nodeIdParser As IUANodeIdParser
Dim s As String
Dim requireNamespace As Boolean
Dim value As UANodeId
 
value = IUANodeIdParserExtension.Parse(nodeIdParser, s, requireNamespace)

[Extension()]
[NotNull()]
public static UANodeId Parse( 
   IUANodeIdParser nodeIdParser,
   string s,
   bool requireNamespace
)

[Extension()]
[NotNull()]
public:
static UANodeId^ Parse( 
   IUANodeIdParser^ nodeIdParser,
   String^ s,
   bool requireNamespace
)

Parameters

nodeIdParser

The OPC-UA node Id parser.

This is typically the OpcLabs.EasyOpc.UA.AddressSpace.Parsing.UANodeIdParser object.

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

s

Expanded text of the node Id.

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

requireNamespace

Determines whether the node Id must contain a namespace or namespace index.

Return Value

Returns the OPC-UA node Id object parsed from the input value.

Because there is an implicit conversion from OpcLabs.EasyOpc.UA.AddressSpace.UANodeId to OpcLabs.EasyOpc.UA.UANodeDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UANodeId in any place where the OpcLabs.EasyOpc.UA.UANodeDescriptor is expected as input, and the corresponding node descriptor will be constructed automatically.

Also, because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion to System.String, and it converts to the expanded text of the node Id (ExpandedText), in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned OpcLabs.EasyOpc.UA.AddressSpace.UANodeId in any place where expanded text of a node Id (a string) is expected as input, and the corresponding expanded text will be taken automatically from the node Id.

This method never returns 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.
OpcLabs.EasyOpc.UA.AddressSpace.Parsing.UANodeIdFormatException	The string format of the OPC-UA node ID is incorrect.

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.EasyOpc.UA.AddressSpace.Parsing.UANodeIdFormatException The string format of the OPC-UA node ID is incorrect.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

IUANodeIdParserExtension Class
IUANodeIdParserExtension Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support