LocaleId Property (UAClientSessionParameters)

Locale id to be used by the server for localized strings.

Syntax

[NotNull()]
public string LocaleId {get; set;}

[NotNull()]
public:
property String^ LocaleId {
   String^ get();
   void set (    String^ value);
}

'Declaration
 
<NotNullAttribute()>
Public Property LocaleId As String

'Usage
 
Dim instance As UAClientSessionParameters
Dim value As String
 
instance.LocaleId = value
 
value = instance.LocaleId

Property Value

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

The default value of this property is "" (String.Empty).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

If the Server returns a localized string to the, the Server shall return the translation for this locale id. If it does not have a translation for this locale id, then it shall return the string value that it has and include the locale id with the string.

In order to obtain or modify this parameter, in the default state (when OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated equals to false), access UAClientAdaptableParameters.SessionParameters property of static OpcLabs.EasyOpc.UA.EasyUAClientCore.AdaptableParameters. If you have set OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated to true, you need to access UAClientAdaptableParameters.SessionParameters property of OpcLabs.EasyOpc.UA.EasyUAClientCore.IsolatedParameters.

The getter method of this property is pure, i.e. it does not have observable side effects.

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

UAClientSessionParameters Class
UAClientSessionParameters Members

Documentation Home, Send Documentation Feedback. Technical Support