OPC Studio User's Guide and Reference
FindInstanceCertificatePrivateKeyPassword Method (UAClientServerApplicationParameters)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.Engine Namespace > UAClientServerApplicationParameters Class : FindInstanceCertificatePrivateKeyPassword Method
The instance certificate sub-id for which the private key should be obtained. Empty string for the default instance certificate.

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

Finds the private key password configured for the given instance certificate sub-id.
Syntax
'Declaration
 
<NotNullAttribute()>
Public Function FindInstanceCertificatePrivateKeyPassword( _
   ByVal certificateSubId As String _
) As String
'Usage
 
Dim instance As UAClientServerApplicationParameters
Dim certificateSubId As String
Dim value As String
 
value = instance.FindInstanceCertificatePrivateKeyPassword(certificateSubId)
[NotNull()]
public string FindInstanceCertificatePrivateKeyPassword( 
   string certificateSubId
)
[NotNull()]
public:
String^ FindInstanceCertificatePrivateKeyPassword( 
   String^ certificateSubId
) 

Parameters

certificateSubId
The instance certificate sub-id for which the private key should be obtained. Empty string for the default instance certificate.

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

Return Value

Returns the private key password configured for the instance certificate sub-id given by the certificateSubId, or an empty string if no private key password has been configured for the certificateSubId.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

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.

Remarks

In order to get the private key password for the default instance certificate, you can also use the InstanceCertificatePrivateKeyPassword property.

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