Connectivity Software User's Guide and Reference
Format(String) Method



OpcLabs.EasyOpcUAPrimitives Assembly > OpcLabs.EasyOpc.UA.AddressSpace Namespace > UANodeId Class > Format Method : Format(String) Method
The default namespace URI string. When this parameter is not a null reference, 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 can be null (Nothing in Visual Basic).

Formats the node Id object into a string.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Function Format( _
   ByVal defaultNamespaceUriString As String _
) As String
'Usage
 
Dim instance As UANodeId
Dim defaultNamespaceUriString As String
Dim value As String
 
value = instance.Format(defaultNamespaceUriString)
[JetBrains.Annotations.NotNull()]
public string Format( 
   string defaultNamespaceUriString
)
[JetBrains.Annotations.NotNull()]
public:
String^ Format( 
   String^ defaultNamespaceUriString
) 

Parameters

defaultNamespaceUriString
The default namespace URI string. When this parameter is not a null reference, 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 can be null (Nothing in Visual Basic).

Return Value

The formatted node Id string (expanded text).

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

Remarks

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

OPC UA node Id, represented by the UANodeId class, directly identifies a node in a server's address space.

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

Reference

UANodeId Class
UANodeId Members
Overload List
OPC UA Node IDs
Namespace indices in OPC UA Node Ids