OPC Studio User's Guide and Reference
ObtainNewCertificateAsync(IEasyUAClientServerApplication,UACertificateRequestParameters) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.Extensions Namespace > IEasyUAClientServerApplicationExtension Class > ObtainNewCertificateAsync Method : ObtainNewCertificateAsync(IEasyUAClientServerApplication,UACertificateRequestParameters) Method
The OPC UA client/server application object that will perform the operation.

In client applications, this is typically obtained by calling System.IServiceProvider.GetService(System.Type) on the OpcLabs.EasyOpc.UA.IEasyUAClient (EasyUAClient object) with the type of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication as an argument.

The value of this parameter cannot be null (Nothing in Visual Basic).

The parameters describing how the certificate should be obtained.

The value of this parameter cannot be null (Nothing in Visual Basic).

Asynchronously obtains a new certificate from the certificate manager, specifying the certificate request parameters.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function ObtainNewCertificateAsync( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal parameters As UACertificateRequestParameters _
) As Task(Of IPkiCertificate)
'Usage
 
Dim application As IEasyUAClientServerApplication
Dim parameters As UACertificateRequestParameters
Dim value As Task(Of IPkiCertificate)
 
value = IEasyUAClientServerApplicationExtension.ObtainNewCertificateAsync(application, parameters)

Parameters

application
The OPC UA client/server application object that will perform the operation.

In client applications, this is typically obtained by calling System.IServiceProvider.GetService(System.Type) on the OpcLabs.EasyOpc.UA.IEasyUAClient (EasyUAClient object) with the type of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication as an argument.

The value of this parameter cannot be null (Nothing in Visual Basic).

parameters
The parameters describing how the certificate should be obtained.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

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

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

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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