ProtectOrUnprotectOwnCertificate Method (_EasyUAClientServerApplication)

Protects or unprotects the private key of the given certificate.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Function ProtectOrUnprotectOwnCertificate( _
   ByVal certificateSubId As String, _
   ByVal newPrivateKeyPassword As String _
) As Boolean

'Usage
 
Dim instance As _EasyUAClientServerApplication
Dim certificateSubId As String
Dim newPrivateKeyPassword As String
Dim value As Boolean
 
value = instance.ProtectOrUnprotectOwnCertificate(certificateSubId, newPrivateKeyPassword)

bool ProtectOrUnprotectOwnCertificate( 
   string certificateSubId,
   string newPrivateKeyPassword
)

bool ProtectOrUnprotectOwnCertificate( 
   String^ certificateSubId,
   String^ newPrivateKeyPassword
)

Parameters

certificateSubId: The sub-id of the certificate. Normally an empty string.
The value of this parameter can 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 can 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

System.Exception An error has occurred during application execution.

Exception	Description
System.Exception	An error has occurred during application execution.
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 member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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

_EasyUAClientServerApplication Interface
_EasyUAClientServerApplication Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.