QuickOPC User's Guide and Reference
BeginObtainNewCertificate Method (IEasyUAApplication)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application Namespace > IEasyUAApplication Interface : BeginObtainNewCertificate Method
The GDS endpoint acting as OPC UA certificate manager (CM).
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 instance certificate from the certificate manager, and stores it for subsequent usage.
Syntax
'Declaration
 
<NotNullAttribute()>
Function BeginObtainNewCertificate( _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal parameters As UAObtainNewCertificateParameters, _
   ByVal asyncCallback As AsyncCallback, _
   ByVal state As Object, _
   ByVal progress As IProgress(Of String()) _
) As IAsyncResult
'Usage
 
Dim instance As IEasyUAApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim parameters As UAObtainNewCertificateParameters
Dim asyncCallback As AsyncCallback
Dim state As Object
Dim progress As IProgress(Of String())
Dim value As IAsyncResult
 
value = instance.BeginObtainNewCertificate(gdsEndpointDescriptor, parameters, asyncCallback, state, progress)

Parameters

gdsEndpointDescriptor
The GDS endpoint acting as OPC UA certificate manager (CM).
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.
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 OpcLabs.EasyOpc.UA.Application.Extensions.IEasyUAApplicationExtension.ObtainNewCertificate extension method and its overloads.

For a task-based asynchronous programming pattern alternative, see the OpcLabs.EasyOpc.UA.Application.Extensions.IEasyUAApplicationExtension.ObtainNewCertificateAsync 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 2012 R2, Windows Server 2016; .NET Core, .NET 6: Linux, macOS, Microsoft Windows

See Also