ProtectOrUnprotectOwnCertificate Method (IEasyUAClientServerApplicationExtension)

Protects or unprotects the private key of the default certificate.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Shared Function ProtectOrUnprotectOwnCertificate( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal newPrivateKeyPassword As String _
) As Boolean

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim newPrivateKeyPassword As String
Dim value As Boolean
 
value = IEasyUAClientServerApplicationExtension.ProtectOrUnprotectOwnCertificate(application, newPrivateKeyPassword)

[Extension()]
public static bool ProtectOrUnprotectOwnCertificate( 
   IEasyUAClientServerApplication application,
   string newPrivateKeyPassword
)

[Extension()]
public:
static bool ProtectOrUnprotectOwnCertificate( 
   IEasyUAClientServerApplication^ application,
   String^ newPrivateKeyPassword
)

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).

newPrivateKeyPassword

Empty string to unprotected the certificate, or a non-empty password to use for protection of the certificate's private key.

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

Return Value

Returns true when the resulting state of the certificate is protected. Returns false otherwise.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	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.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

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.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

A preexisting private key password, if any, must be correctly configured in the application, for this operation to succeed.

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

Reference

IEasyUAClientServerApplicationExtension Class
IEasyUAClientServerApplicationExtension Members

Documentation Home, Send Documentation Feedback. Technical Support