MessageSecurityModeName Property (UAEndpointSelectionPolicy)

Specifies the name of the message security mode of the endpoint.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<IgnoreDataMemberAttribute()>
<NotNullAttribute()>
<TypeConverterAttribute(OpcLabs.BaseLib.ComponentModel.Internal.ValuesStandardPropertyConverter)>
<XmlIgnoreAttribute()>
Public Property MessageSecurityModeName As String

'Usage
 
Dim instance As UAEndpointSelectionPolicy
Dim value As String
 
instance.MessageSecurityModeName = value
 
value = instance.MessageSecurityModeName

[IgnoreDataMember()]
[NotNull()]
[TypeConverter(OpcLabs.BaseLib.ComponentModel.Internal.ValuesStandardPropertyConverter)]
[XmlIgnore()]
public string MessageSecurityModeName {get; set;}

[IgnoreDataMember()]
[NotNull()]
[TypeConverter(OpcLabs.BaseLib.ComponentModel.Internal.ValuesStandardPropertyConverter)]
[XmlIgnore()]
public:
property String^ MessageSecurityModeName {
   String^ get();
   void set (    String^ value);
}

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.ArgumentException	One of the arguments provided to a method is not valid. 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.

System.ArgumentException

One of the arguments provided to a method is not valid.

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

An empty string when the allowed message security modes do not specify precisely one mode.

Example values:

"None",
"Sign",
"SignAndEncrypt".

In order to obtain or modify this parameter, in the default state (when OpcLabs.EasyOpc.UA.EasyUAClientCore.Isolated equals to false), access EndpointSelectionPolicy property of 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 EndpointSelectionPolicy property of UAClientAdaptableParameters.SessionParameters property of OpcLabs.EasyOpc.UA.EasyUAClientCore.IsolatedParameters.

Alternatively, you can override the endpoint selection policy for a specific endpoint by setting it to a non-null value in OpcLabs.EasyOpc.UA.UAEndpointDescriptor.EndpointSelectionPolicy.

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

UAEndpointSelectionPolicy Class
UAEndpointSelectionPolicy Members

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

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.