OPC Studio User's Guide and Reference
Format Method (UAQualifiedNameExtension)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.AddressSpace.Extensions Namespace > UAQualifiedNameExtension Class : Format Method
The qualified name.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the qualified name) in place of this parameter, and the corresponding OPC UA qualified name will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UAQualifiedName Constructor(String) constructor instead.

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

The default namespace URI string. When this parameter is not an empty string, the formatted string will not explicitly include the namespace specifier if the namespace is equal to the default 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 cannot be null (Nothing in Visual Basic).

Formats the qualified name object into a string.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function Format( _
   ByVal qualifiedName As UAQualifiedName, _
   ByVal defaultNamespaceUriString As String _
) As String
'Usage
 
Dim qualifiedName As UAQualifiedName
Dim defaultNamespaceUriString As String
Dim value As String
 
value = UAQualifiedNameExtension.Format(qualifiedName, defaultNamespaceUriString)

Parameters

qualifiedName
The qualified name.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the qualified name) in place of this parameter, and the corresponding OPC UA qualified name will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UAQualifiedName Constructor(String) constructor instead.

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

defaultNamespaceUriString
The default namespace URI string. When this parameter is not an empty string, the formatted string will not explicitly include the namespace specifier if the namespace is equal to the default 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 cannot be null (Nothing in Visual Basic).

Return Value

The formatted qualified name string (expanded text).

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.

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

See Also