QuickOPC User's Guide and Reference
ObtainNewCertificate(IEasyUAApplication,UAEndpointDescriptor,UAObtainNewCertificateParameters) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace > IEasyUAApplicationExtension Class > ObtainNewCertificate Method : ObtainNewCertificate(IEasyUAApplication,UAEndpointDescriptor,UAObtainNewCertificateParameters) Method
The OPC UA client application object that will perform the operation.
The GDS endpoint acting as OPC UA certificate manager (CM).
The parameters describing how the certificate should be obtained.
Obtains a new application instance certificate from the certificate manager, and stores it for subsequent usage.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ObtainNewCertificate( _
   ByVal application As IEasyUAApplication, _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal parameters As UAObtainNewCertificateParameters _
) As IPkiCertificate
'Usage
 
Dim application As IEasyUAApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim parameters As UAObtainNewCertificateParameters
Dim value As IPkiCertificate
 
value = IEasyUAApplicationExtension.ObtainNewCertificate(application, gdsEndpointDescriptor, parameters)

Parameters

application
The OPC UA client application object that will perform the operation.
gdsEndpointDescriptor
The GDS endpoint acting as OPC UA certificate manager (CM).
parameters
The parameters describing how the certificate should be obtained.

Return Value

Returns the certificate obtained from the certificate manager.
Exceptions
ExceptionDescription
A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.
An operation that the thread was execution has been cancelled.
The OPC UA operation has failed.
Remarks

The operation is synchronous. It can take considerable time to execute, 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).

For an alternative based on asynchronous programming model (APM, System.IAsyncResult) pattern, see the BeginObtainNewCertificate method and related extension methods.

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

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