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



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.AddressSpace Namespace > UANodeId Class : Format Method

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 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 of this parameter can be null (Nothing in Visual Basic).

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.

Determines whether node IDs that have a standard name will be formatted as the standard name only.
Formats the node Id object into a string.
Syntax
'Declaration
 
Public Function Format( _
   ByVal defaultNamespaceUriString As String, _
   ByVal useStandardNames As Boolean _
) As String
'Usage
 
Dim instance As UANodeId
Dim defaultNamespaceUriString As String
Dim useStandardNames As Boolean
Dim value As String
 
value = instance.Format(defaultNamespaceUriString, useStandardNames)

Parameters

defaultNamespaceUriString

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 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 of this parameter can be null (Nothing in Visual Basic).

useStandardNames

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.

Determines whether node IDs that have a standard name will be formatted as the standard name only.

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.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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
OPC UA Node IDs
Namespace indices in OPC UA Node Ids