EndpointSelectionPolicy Property (UAClientSessionParameters)

Determines how the UA client chooses the endpoint from the endpoints provided by the UA server.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property EndpointSelectionPolicy As UAEndpointSelectionPolicy

'Usage
 
Dim instance As UAClientSessionParameters
Dim value As UAEndpointSelectionPolicy
 
instance.EndpointSelectionPolicy = value
 
value = instance.EndpointSelectionPolicy

public UAEndpointSelectionPolicy EndpointSelectionPolicy {get; set;}

public:
property UAEndpointSelectionPolicy^ EndpointSelectionPolicy {
   UAEndpointSelectionPolicy^ get();
   void set (    UAEndpointSelectionPolicy^ value);
}

Property Value

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

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

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.

Because the UAEndpointSelectionPolicy has an implicit conversion from UAMessageSecurityModes, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a UAMessageSecurityModes in place of UAEndpointSelectionPolicy value when setting this property, and the corresponding OPC UA endpoint selection policy will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UAEndpointSelectionPolicy.UAEndpointSelectionPolicy Constructor(UAMessageSecurityModes) constructor instead.

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 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.