RegisterApplication Method (IEasyUAGlobalDiscoveryClient)

Registers a new application instance with a Global Directory Server.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function RegisterApplication( _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal applicationRecord As UAApplicationRecordDataType _
) As UANodeId

'Usage
 
Dim instance As IEasyUAGlobalDiscoveryClient
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim applicationRecord As UAApplicationRecordDataType
Dim value As UANodeId
 
value = instance.RegisterApplication(gdsEndpointDescriptor, applicationRecord)

[NotNull()]
UANodeId RegisterApplication( 
   UAEndpointDescriptor gdsEndpointDescriptor,
   UAApplicationRecordDataType applicationRecord
)

[NotNull()]
UANodeId^ RegisterApplication( 
   UAEndpointDescriptor^ gdsEndpointDescriptor,
   UAApplicationRecordDataType^ applicationRecord
)

Parameters

gdsEndpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server. The server must be a Global Directory Server (GDS).
applicationRecord: Describes the application that is to be registered.

Return Value

Returns an application ID, which is a unique identifier for the registered application.

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 register the current client application, it is recommended that you use the higher-level OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication.RegisterToGds 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

IEasyUAGlobalDiscoveryClient Interface
IEasyUAGlobalDiscoveryClient Members

Send Documentation Feedback. Technical Support