SetPrivateKeyPassword Method (IEasyUAClientServerApplication)

Sets the password used to access the private key for given certificate.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Sub SetPrivateKeyPassword( _
   ByVal certificateSubId As String, _
   ByVal privateKeyPassword As String _
)

'Usage
 
Dim instance As IEasyUAClientServerApplication
Dim certificateSubId As String
Dim privateKeyPassword As String
 
instance.SetPrivateKeyPassword(certificateSubId, privateKeyPassword)

void SetPrivateKeyPassword( 
   string certificateSubId,
   string privateKeyPassword
)

void SetPrivateKeyPassword( 
   String^ certificateSubId,
   String^ privateKeyPassword
)

Parameters

certificateSubId: The sub-id of the certificate. Normally an empty string.
The value of this parameter cannot be null (Nothing in Visual Basic).
privateKeyPassword: The private key password to be associated with the given certificate.
The value of this parameter cannot be null (Nothing in Visual Basic).

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

This method is used to secure the private key of a certificate by setting a password. It is important for the protection of the private key, ensuring that it cannot be used without the correct password. The certificateSubId parameter is used to specify which certificate's private key password is being set.

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

IEasyUAClientServerApplication Interface
IEasyUAClientServerApplication Members

Documentation Home, Send Documentation Feedback. Technical Support