ProtocolName Property (_UAEndpointSelectionPolicy)

Specifies the name of the protocol of the endpoint.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Property ProtocolName As String

'Usage
 
Dim instance As _UAEndpointSelectionPolicy
Dim value As String
 
instance.ProtocolName = value
 
value = instance.ProtocolName

[NotNull()]
string ProtocolName {get; set;}

[NotNull()]
property String^ ProtocolName {
   String^ get();
   void set (    String^ value);
}

Property Value

This value of this property can be null (Nothing in Visual Basic).

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

An empty string allows any protocol. For available protocol names, see OpcLabs.EasyOpc.UA.Engine.UAProtocolNames.

Example values:

"HTTP",
"HTTPS",
"TCP".

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 OpcLabs.EasyOpc.UA.Engine.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 OpcLabs.EasyOpc.UA.Engine.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.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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 Interface
_UAEndpointSelectionPolicy Members

Documentation Home, Send Documentation Feedback. Technical Support