SetPrivateKeyPassword Method (IEasyUAClientServerApplicationExtension)

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

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Shared Sub SetPrivateKeyPassword( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal privateKeyPassword As String _
)

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim privateKeyPassword As String
 
IEasyUAClientServerApplicationExtension.SetPrivateKeyPassword(application, privateKeyPassword)

[Extension()]
public static void SetPrivateKeyPassword( 
   IEasyUAClientServerApplication application,
   string privateKeyPassword
)

[Extension()]
public:
static void SetPrivateKeyPassword( 
   IEasyUAClientServerApplication^ application,
   String^ privateKeyPassword
)

Parameters

application: The OPC UA client/server application object that will perform the operation.
privateKeyPassword: The private key password to be associated with the default certificate.

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.

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

Send Documentation Feedback. Technical Support