QuickOPC User's Guide and Reference
BeginObtainNewCertificate(IEasyUAClientServerApplication,UACertificateRequestParameters,AsyncCallback,Object,IProgress<String[]>) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace > IEasyUAClientServerApplicationExtension Class > BeginObtainNewCertificate Method : BeginObtainNewCertificate(IEasyUAClientServerApplication,UACertificateRequestParameters,AsyncCallback,Object,IProgress<String[]>) Method
The OPC UA client/server application object that will perform the operation.
The parameters describing how the certificate should be obtained.
The delegate that is executed when the operation completes.
An object that contains any additional user-defined data.
A provider for progress updates.
Begins an asynchronous operation that obtains a new application own certificate from the certificate manager, and stores it for subsequent usage.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function BeginObtainNewCertificate( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal parameters As UACertificateRequestParameters, _
   ByVal asyncCallback As AsyncCallback, _
   ByVal state As Object, _
   ByVal progress As IProgress(Of String()) _
) As IAsyncResult
'Usage
 
Dim application As IEasyUAClientServerApplication
Dim parameters As UACertificateRequestParameters
Dim asyncCallback As AsyncCallback
Dim state As Object
Dim progress As IProgress(Of String())
Dim value As IAsyncResult
 
value = IEasyUAClientServerApplicationExtension.BeginObtainNewCertificate(application, parameters, asyncCallback, state, progress)

Parameters

application
The OPC UA client/server application object that will perform the operation.
parameters
The parameters describing how the certificate should be obtained.
asyncCallback
The delegate that is executed when the operation completes.
state
An object that contains any additional user-defined data.
progress
A provider for progress updates.

Return Value

Returns a status object that represents the asynchronous call.
Exceptions
ExceptionDescription

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

See Also