ToString() Method

Returns a string that represents the current object.Returns a string that represents the current object. Converts the various fields of a status code to a string.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Overloads Overrides NotOverridable Function ToString() As String

'Usage
 
Dim instance As UAStatusCode
Dim value As String
 
value = instance.ToString()

[NotNull()]
public override string ToString()

[NotNull()]
public:
String^ ToString(); override

Return Value

A string that represents the current object.A string that represents the current object.Returns the status code converted to a string.

Example

// This example shows how the OPC UA status codes are formatted to a string containing their symbolic name.

using System;
using OpcLabs.EasyOpc.UA;

namespace UADocExamples._UAStatusCode
{
    class ToString
    {
        public static void Main1()
        {
            long[] internalValueArray = { 0, 0x80010000, 2147614720, 0x80340000 };

            foreach (long internalValue in internalValueArray)
                Console.WriteLine($"{internalValue}: {new UAStatusCode(internalValue)}");


            // Example output:
            //0: Good
            //2147549184: BadUnexpectedError
            //2147614720: BadInternalError
            //2150891520: BadNodeIdUnknown
        }
    }
}

# This example shows how the OPC UA status codes are formatted to a string containing their symbolic name.

# The QuickOPC package is needed. Install it using "pip install opclabs_quickopc".
import opclabs_quickopc

# Import .NET namespaces.
from System import *
from OpcLabs.EasyOpc.UA import *


internalValueArray = [0, 0x80010000, 2147614720, 0x80340000]

for internalValue in internalValueArray:
    print(internalValue, ': ', UAStatusCode(internalValue), sep='')

print()
print('Finished.')


# Example output:
# 0: Good
# 2147549184: BadUnexpectedError
# 2147614720: BadInternalError
# 2150891520: BadNodeIdUnknown
#
# Finished.

Requirements

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

Reference

UAStatusCode Class
UAStatusCode Members
Overload List
Base Implementation in ToString

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.