ProtectOwnCertificateOrCertificatePack(IEasyUAClientServerApplication,String,UANodeId,String) Method

Protects the private key of the certificate or certificate pack, specifying the certificate sub-id.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Sub ProtectOwnCertificateOrCertificatePack( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal certificateSubId As String, _
   ByVal certificateTypeId As UANodeId, _
   ByVal newPrivateKeyPassword As String _
)

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim certificateSubId As String
Dim certificateTypeId As UANodeId
Dim newPrivateKeyPassword As String
 
IEasyUAClientServerApplicationExtension.ProtectOwnCertificateOrCertificatePack(application, certificateSubId, certificateTypeId, newPrivateKeyPassword)

[Extension()]
public static void ProtectOwnCertificateOrCertificatePack( 
   IEasyUAClientServerApplication application,
   string certificateSubId,
   UANodeId certificateTypeId,
   string newPrivateKeyPassword
)

[Extension()]
public:
static void ProtectOwnCertificateOrCertificatePack( 
   IEasyUAClientServerApplication^ application,
   String^ certificateSubId,
   UANodeId^ certificateTypeId,
   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).

certificateSubId

The sub-id of the certificate. Normally an empty string.

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

certificateTypeId

The certificate type Id, or null (Nothing in Visual Basic) for certificate pack.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UANodeId has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the nodeId) in place of this parameter, and the corresponding OPC UA node Id will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the UANodeId Constructor(String) constructor instead.

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

newPrivateKeyPassword

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

Exceptions

Exception Description

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. 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.
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.ArgumentException

One of the arguments provided to a method is not valid.

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.

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 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
Overload List
PackCertificateTypeIds Property

Documentation Home, Send Documentation Feedback. Technical Support