GetApplicationId Method (_EasyUAClientApplication)

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

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function GetApplicationId( _
   ByVal gdsEndpointDescriptor As Object _
) As UANodeId

'Usage
 
Dim instance As _EasyUAClientApplication
Dim gdsEndpointDescriptor As Object
Dim value As UANodeId
 
value = instance.GetApplicationId(gdsEndpointDescriptor)

[NotNull()]
UANodeId GetApplicationId( 
   object gdsEndpointDescriptor
)

[NotNull()]
UANodeId^ GetApplicationId( 
   Object^ gdsEndpointDescriptor
)

Parameters

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
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed.
System.Exception	An error has occurred during method execution.

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 2012 R2, Windows Server 2016; .NET Core, .NET 6: Linux, macOS, Microsoft Windows

Reference

_EasyUAClientApplication Interface
_EasyUAClientApplication Members

Send Feedback