OPC Studio User's Guide and Reference
Format(UAQualifiedNameCollection,String) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.AddressSpace.Extensions Namespace > UAQualifiedNameCollectionExtension Class > Format Method : Format(UAQualifiedNameCollection,String) Method
The qualified name collection.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

The default namespace URI string. When this parameter is not a null reference, the formatted string will not explicitly include the namespace specifier with the target name if it 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 can be null (Nothing in Visual Basic).

Formats the qualified name collection (a simple relative path) into a string.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function Format( _
   ByVal qualifiedNameCollection As UAQualifiedNameCollection, _
   ByVal defaultNamespaceUriString As String _
) As String
'Usage
 
Dim qualifiedNameCollection As UAQualifiedNameCollection
Dim defaultNamespaceUriString As String
Dim value As String
 
value = UAQualifiedNameCollectionExtension.Format(qualifiedNameCollection, defaultNamespaceUriString)

Parameters

qualifiedNameCollection
The qualified name collection.

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

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

defaultNamespaceUriString
The default namespace URI string. When this parameter is not a null reference, the formatted string will not explicitly include the namespace specifier with the target name if it 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 can be null (Nothing in Visual Basic).

Return Value

The formatted simple relative path string.

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

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