BeginObtainNewCertificate Method (IEasyUAClientServerApplication)

Begins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function BeginObtainNewCertificate( _
   ByVal arguments As UAObtainCertificateArguments, _
   ByVal asyncCallback As AsyncCallback, _
   ByVal state As Object, _
   ByVal progress As IProgress(Of String()) _
) As IAsyncResult

'Usage
 
Dim instance As IEasyUAClientServerApplication
Dim arguments As UAObtainCertificateArguments
Dim asyncCallback As AsyncCallback
Dim state As Object
Dim progress As IProgress(Of String())
Dim value As IAsyncResult
 
value = instance.BeginObtainNewCertificate(arguments, asyncCallback, state, progress)

[NotNull()]
IAsyncResult BeginObtainNewCertificate( 
   UAObtainCertificateArguments arguments,
   AsyncCallback asyncCallback,
   object state,
   IProgress<string[]> progress
)

[NotNull()]
IAsyncResult^ BeginObtainNewCertificate( 
   UAObtainCertificateArguments^ arguments,
   AsyncCallback^ asyncCallback,
   Object^ state,
   IProgress<array<String^>>^ progress
)

Parameters

arguments: Contains arguments for obtaining a new application certificate from the OPC UA Global Discovery Server (GDS).
The value of this parameter cannot be null (Nothing in Visual Basic).
asyncCallback: The delegate that is executed when the operation completes.
The value of this parameter can be null (Nothing in Visual Basic).
state: An object that contains any additional user-defined data.
The value of this parameter can be null (Nothing in Visual Basic).
progress: A provider for progress updates.
The value of this parameter can be null (Nothing in Visual Basic).

Return Value

Returns a status object that represents the asynchronous call.

This method never returns null (Nothing in Visual Basic).

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.

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.

Remarks

The operation is asynchronous, because it involves multiple steps, and waiting for a finalization of the request by the GDS (see the OpcLabs.EasyOpc.UA.Gds.IEasyUACertificateManagement.FinishRequest method). End of the operation is handled by the EndObtainNewCertificate method. The operation can be cancelled using the CancelObtainNewCertificate method.

For a synchronous alternative, see the ObtainNewCertificate(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

For a task-based asynchronous programming pattern alternative, see the ObtainNewCertificateAsync(IEasyUAClientServerApplication,UAEndpointDescriptor) extension method and its overloads.

The operation first updates the application's registration in the GDS, before making a request to the certificate manager.

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

IEasyUAClientServerApplication Interface
IEasyUAClientServerApplication Members

Documentation Home, Send Documentation Feedback. Technical Support