GetPrivateKeyPasswordStrength Method (IEasyUAClientServerApplication)

Determines strength of the password that is configured for use with the given certificate.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<PureAttribute()>
Function GetPrivateKeyPasswordStrength( _
   ByVal certificateSubId As String _
) As Single

'Usage
 
Dim instance As IEasyUAClientServerApplication
Dim certificateSubId As String
Dim value As Single
 
value = instance.GetPrivateKeyPasswordStrength(certificateSubId)

[Pure()]
float GetPrivateKeyPasswordStrength( 
   string certificateSubId
)

[Pure()]
float GetPrivateKeyPasswordStrength( 
   String^ certificateSubId
)

Parameters

certificateSubId: The sub-id of the certificate. Normally an empty string.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns zero when there is no password configured. Returns a positive number indicating the relative strength of the password otherwise.

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 pure, i.e. it does not have observable side effects.

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