FindOwnCertificate Method (IEasyUAClientServerApplication)

Finds the own certificate the application is currently configured to use.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
<JetBrains.Annotations.MustUseReturnValueAttribute()>
Function FindOwnCertificate( _
   ByVal certificateSubId As String, _
   ByVal certificateTypeId As UANodeId _
) As IPkiCertificate

'Usage
 
Dim instance As IEasyUAClientServerApplication
Dim certificateSubId As String
Dim certificateTypeId As UANodeId
Dim value As IPkiCertificate
 
value = instance.FindOwnCertificate(certificateSubId, certificateTypeId)

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.MustUseReturnValue()]
IPkiCertificate FindOwnCertificate( 
   string certificateSubId,
   UANodeId certificateTypeId
)

[JetBrains.Annotations.CanBeNull()]
[JetBrains.Annotations.MustUseReturnValue()]
IPkiCertificate^ FindOwnCertificate( 
   String^ certificateSubId,
   UANodeId^ certificateTypeId
)

Parameters

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.

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 cannot be null (Nothing in Visual Basic).

Return Value

Returns the own certificate, if found. Returns null if the own certificate cannot be found.

This method can return null (Nothing in Visual Basic).

This return value of this method should not be ignored.

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.
System.ObjectDisposedException	An operation was performed on a disposed object.
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.

System.ObjectDisposedException An operation was performed on a disposed object.

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

If the specified certificate type Id is Null, the default certificate type Id from DefaultCertificateTypeId is used instead.

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
CreateOwnCertificateOrCertificatePack Method
GetOwnCertificatePack(IEasyUAClientServerApplication,String) Method
RemoveOwnCertificatesOrCertificatePack Method

Documentation Home, Send Documentation Feedback. Technical Support