GdsEndpointDescriptor Property (_UAClientServerEngineParameters)

The endpoint descriptor of the Global Discover Server (GDS) that will be used for performing the discovery.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Property GdsEndpointDescriptor As UAEndpointDescriptor

'Usage
 
Dim instance As _UAClientServerEngineParameters
Dim value As UAEndpointDescriptor
 
instance.GdsEndpointDescriptor = value
 
value = instance.GdsEndpointDescriptor

[NotNull()]
UAEndpointDescriptor GdsEndpointDescriptor {get; set;}

[NotNull()]
property UAEndpointDescriptor^ GdsEndpointDescriptor {
   UAEndpointDescriptor^ get();
   void set (    UAEndpointDescriptor^ 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, access OpcLabs.EasyOpc.UA.EasyUAClientCore.InstanceParameters.

Not directly used on COM platform by any of the OpcLabs.EasyOpc.UA.ComTypes._EasyUAClient methods, because wherever applicable, they always include an argument that specifies this value explicitly.

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

Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has an implicit conversion from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, when setting this property, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromUri static method instead.

Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to OpcLabs.EasyOpc.UA.UAEndpointDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement (results from OPC UA discovery) in place of OpcLabs.EasyOpc.UA.UAEndpointDescriptor when setting this property, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a (non-null) OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement to OpcLabs.EasyOpc.UA.UAEndpointDescriptor using the ToUAEndpointDescriptor or ToUAEndpointDescriptor method instead.

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

_UAClientServerEngineParameters Interface
_UAClientServerEngineParameters Members

Documentation Home, Send Documentation Feedback. Technical Support