OPC Studio User's Guide and Reference
DiscoverGlobalApplications(IEasyUAClient,UAEndpointDescriptor,UAQueryApplicationsFilter) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA Namespace > IEasyUAClientExtension Class > DiscoverGlobalApplications Method : DiscoverGlobalApplications(IEasyUAClient,UAEndpointDescriptor,UAQueryApplicationsFilter) Method
The client object that will perform the operation.

This is typically the EasyUAClient object.

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

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

Because the UAEndpointDescriptor has implicit conversions 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, in place of this parameter, 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 UAEndpointDescriptor.FromString or UAEndpointDescriptor.FromUri static method instead.

Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to 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 this parameter, 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 UAEndpointDescriptor using the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement.ToUAEndpointDescriptor or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement.ToUAEndpointDescriptor method instead.

If you are using OPC Wizard (for server development), an implicit conversion from EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.

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

A filter used to find servers that meet the specified criteria.

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

Globally discovers OPC-UA applications, specifying the GDS endpoint, and query applications filter.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.ItemNotNullAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Shared Function DiscoverGlobalApplications( _
   ByVal client As IEasyUAClient, _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal queryApplicationsFilter As UAQueryApplicationsFilter _
) As UADiscoveryElementCollection
'Usage
 
Dim client As IEasyUAClient
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim queryApplicationsFilter As UAQueryApplicationsFilter
Dim value As UADiscoveryElementCollection
 
value = IEasyUAClientExtension.DiscoverGlobalApplications(client, gdsEndpointDescriptor, queryApplicationsFilter)
[Extension()]
[JetBrains.Annotations.ItemNotNull()]
[JetBrains.Annotations.NotNull()]
public static UADiscoveryElementCollection DiscoverGlobalApplications( 
   IEasyUAClient client,
   UAEndpointDescriptor gdsEndpointDescriptor,
   UAQueryApplicationsFilter queryApplicationsFilter
)
[Extension()]
[JetBrains.Annotations.ItemNotNull()]
[JetBrains.Annotations.NotNull()]
public:
static UADiscoveryElementCollection^ DiscoverGlobalApplications( 
   IEasyUAClient^ client,
   UAEndpointDescriptor^ gdsEndpointDescriptor,
   UAQueryApplicationsFilter^ queryApplicationsFilter
) 

Parameters

client
The client object that will perform the operation.

This is typically the EasyUAClient object.

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

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

Because the UAEndpointDescriptor has implicit conversions 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, in place of this parameter, 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 UAEndpointDescriptor.FromString or UAEndpointDescriptor.FromUri static method instead.

Also, because the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement and OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement have an implicit conversion to 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 this parameter, 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 UAEndpointDescriptor using the OpcLabs.EasyOpc.UA.Discovery.UAApplicationElement.ToUAEndpointDescriptor or OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement.ToUAEndpointDescriptor method instead.

If you are using OPC Wizard (for server development), an implicit conversion from EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.

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

queryApplicationsFilter
A filter used to find servers that meet the specified criteria.

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

Return Value

Returns a collection of application elements (servers, OpcLabs.EasyOpc.UA.Discovery.UADiscoveryElement).

This method never returns null (Nothing in Visual Basic).

The individual elements of the returned value are never null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

This method globally discovers OPC-UA applications that meet the specified filters and returns information about them, using the specified GDS endpoint.

This method uses the so-called OPC UA Global Discovery Server (GDS).

See also in Knowledge Base: Technical note-OPC UA Discovery in QuickOPC.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also