OPC Studio User's Guide and Reference
ProtectOwnCertificate Method (_EasyUAApplication)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Application.ComTypes Namespace > _EasyUAApplication Interface : ProtectOwnCertificate Method
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).

Protects the private key of the default certificate.
Syntax
'Declaration
 
Sub ProtectOwnCertificate( _
   ByVal newPrivateKeyPassword As String _
) 
'Usage
 
Dim instance As _EasyUAApplication
Dim newPrivateKeyPassword As String
 
instance.ProtectOwnCertificate(newPrivateKeyPassword)
void ProtectOwnCertificate( 
   string newPrivateKeyPassword
)
void ProtectOwnCertificate( 
   String^ newPrivateKeyPassword
) 

Parameters

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

Exceptions
ExceptionDescription
An error has occurred during application execution.

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.

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.

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.

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

See Also