GetApplicationId Method (IEasyUAClientServerApplicationExtension)

Gets an application ID assigned to the application by a specified GDS.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function GetApplicationId( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor _
) As UANodeId

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim value As UANodeId
 
value = IEasyUAClientServerApplicationExtension.GetApplicationId(application, gdsEndpointDescriptor)

[Extension()]
[NotNull()]
public static UANodeId GetApplicationId( 
   IEasyUAClientServerApplication application,
   UAEndpointDescriptor gdsEndpointDescriptor
)

[Extension()]
[NotNull()]
public:
static UANodeId^ GetApplicationId( 
   IEasyUAClientServerApplication^ application,
   UAEndpointDescriptor^ gdsEndpointDescriptor
)

Parameters

application: The OPC UA client/server application object that will perform the operation.
gdsEndpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server. The server must be a Global Directory Server (GDS).

Return Value

Returns the application ID in the GDS.

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

The method return the application ID cached on the application (client) side, if it is known from previous operations. Otherwise, it contacts the GDS and attempts to find the application registration.

The methods throws an exception if the application registration is not found in the GDS, or if there are multiple registrations for the same application.

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

IEasyUAClientServerApplicationExtension Class
IEasyUAClientServerApplicationExtension Members

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