GetApplication Method (_EasyUAGlobalDiscoveryClient)

Gets a specific application record for an OPC UA application known to GDS.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function GetApplication( _
   ByVal gdsEndpointDescriptor As Object, _
   ByVal applicationId As Object _
) As UAApplicationRecordDataType

'Usage
 
Dim instance As _EasyUAGlobalDiscoveryClient
Dim gdsEndpointDescriptor As Object
Dim applicationId As Object
Dim value As UAApplicationRecordDataType
 
value = instance.GetApplication(gdsEndpointDescriptor, applicationId)

[NotNull()]
UAApplicationRecordDataType GetApplication( 
   object gdsEndpointDescriptor,
   object applicationId
)

[NotNull()]
UAApplicationRecordDataType^ GetApplication( 
   Object^ gdsEndpointDescriptor,
   Object^ applicationId
)

Parameters

gdsEndpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server. The server must be a Global Directory Server (GDS).
applicationId: The application ID that identifies the application of interest.

Return Value

Returns the application record (OpcLabs.EasyOpc.UA.Gds.UAApplicationRecordDataType) that matches the application ID given by .

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

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.

OpcLabs.EasyOpc.UA.OperationModel.UAException

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

If you want to find the registration information for the current client application, it is recommended that you use the higher-level OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.FindGdsRegistrations method 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

_EasyUAGlobalDiscoveryClient Interface
_EasyUAGlobalDiscoveryClient Members

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