OPC Studio User's Guide and Reference
Parse Method (UAQualifiedName)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.AddressSpace Namespace > UAQualifiedName Class : Parse Method
Expanded text of the qualified name.

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

The default namespace to be used if no namespace is specified in the input string.

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

Parses a string containing a qualified name, and returns a corresponding qualified name object.
Syntax
'Declaration
 
<NotNullAttribute()>
Public Shared Function Parse( _
   ByVal expandedText As String, _
   ByVal defaultNamespaceUriString As String _
) As UAQualifiedName
'Usage
 
Dim expandedText As String
Dim defaultNamespaceUriString As String
Dim value As UAQualifiedName
 
value = UAQualifiedName.Parse(expandedText, defaultNamespaceUriString)

Parameters

expandedText
Expanded text of the qualified name.

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

defaultNamespaceUriString
The default namespace to be used if no namespace is specified in the input string.

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 the qualified name object parsed from the input value.

Because the UAQualifiedName has an implicit conversion to System.String, and it converts to the expanded text of the qualified name (ExpandedText), in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned UAQualifiedName in any place where expanded text of a qualified name (a string) is expected as input, and the corresponding expanded text will be taken automatically from the qualified name.

Also, because the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement has an implicit conversion from UAQualifiedName, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned UAQualifiedName (containing a target qualified name, which becomes the "any hierarchical" forward reference) in any place where OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement is expected as input, and the corresponding OPC UA browse path element will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.Navigation.UABrowsePathElement.FromUAQualifiedName static method instead.

Also, because the OpcLabs.EasyOpc.UA.UAReadParameters has an implicit conversions from UAQualifiedName, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply the returned UAQualifiedName (representing the name of the encoding to be used) in any place where OpcLabs.EasyOpc.UA.UAReadParameters is expected as input, and the corresponding OPC UA read parameters will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromDouble or FromUAQualifiedName static method instead.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

The string format of the OPC-UA qualified name is incorrect.
Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also