OPC Studio User's Guide and Reference
FormatPreciseDisplayName Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Extensions Namespace > UAMessageSecurityModesExtension Class : FormatPreciseDisplayName Method
The message security modes.
Formats the display name of the message security modes.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function FormatPreciseDisplayName( _
   ByVal messageSecurityModes As UAMessageSecurityModes _
) As String
'Usage
 
Dim messageSecurityModes As UAMessageSecurityModes
Dim value As String
 
value = UAMessageSecurityModesExtension.FormatPreciseDisplayName(messageSecurityModes)
[Extension()]
[JetBrains.Annotations.NotNull()]
public static string FormatPreciseDisplayName( 
   UAMessageSecurityModes messageSecurityModes
)
[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static String^ FormatPreciseDisplayName( 
   UAMessageSecurityModes messageSecurityModes
) 

Parameters

messageSecurityModes
The message security modes.

Return Value

If the messageSecurityModes specify precisely one mode, returns the corresponding precise display name for that mode. Otherwise, returns an empty string.

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.

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