BeginObtainNewCertificate Method (IEasyUAClientApplication)

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

Syntax

Visual Basic
C#
C++/CLI

'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 IEasyUAClientApplication
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)

[NotNull()]
IAsyncResult BeginObtainNewCertificate( 
   UAEndpointDescriptor gdsEndpointDescriptor,
   UAObtainNewCertificateParameters parameters,
   AsyncCallback asyncCallback,
   object state,
   IProgress<string> progress
)

[NotNull()]
IAsyncResult^ BeginObtainNewCertificate( 
   UAEndpointDescriptor^ gdsEndpointDescriptor,
   UAObtainNewCertificateParameters^ parameters,
   AsyncCallback^ asyncCallback,
   Object^ state,
   IProgress<String^>^ 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.

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.IEasyUACertificateManagementClient.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.IEasyUAClientApplicationExtension.ObtainNewCertificate extension method and its overloads.

For a task-based asynchronous programming pattern alternative, see the OpcLabs.EasyOpc.UA.Application.Extensions.IEasyUAClientApplicationExtension.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.

This method operates (at least in part) asynchronously, with respect to the caller. The actual execution of the operation may be delayed, and the outcome of the operation (if any) is provided to the calling code using an event notification, callback, or other means explained in the text. In a properly written program, this method does not throw any exceptions. You should therefore not put try/catch statements or similar constructs around calls to this method. The only exceptions thrown by this method are for usage errors, i.e. when your code violates the usage contract of the method, such as passing in invalid arguments or calling the method when the state of the object does not allow it. Any operation-related errors (i.e. errors that depend on external conditions that your code cannot reliably check) are indicated by the means the operation returns its outcome (if any), which is described in the text. For more information, see Do not catch any exceptions with asynchronous or multiple-operation methods.

Requirements

Target Platforms: .NET Framework: Windows 7 with SP1, Windows Server 2012; .NET Core: Linux, Microsoft Windows

Reference

IEasyUAClientApplication Interface
IEasyUAClientApplication Members