QuickOPC User's Guide and Reference
GetApplicationId Method (IEasyUAApplicationExtension)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace > IEasyUAApplicationExtension Class : GetApplicationId Method
The OPC UA client application object that will perform the operation.
Endpoint descriptor. Identifies the OPC-UA server. The server must be a Global Directory Server (GDS).
Gets an application ID assigned to the application by a specified GDS.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function GetApplicationId( _
   ByVal application As IEasyUAApplication, _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor _
) As UANodeId
'Usage
 
Dim application As IEasyUAApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim value As UANodeId
 
value = IEasyUAApplicationExtension.GetApplicationId(application, gdsEndpointDescriptor)
[Extension()]
[NotNull()]
public static UANodeId GetApplicationId( 
   IEasyUAApplication application,
   UAEndpointDescriptor gdsEndpointDescriptor
)

Parameters

application
The OPC UA client 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
ExceptionDescription
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
The OPC UA operation has failed.
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

See Also