RemoveOwnCertificates Method (IEasyUAClientServerApplication)

Removes the own certificates the application is currently configured to use.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Function RemoveOwnCertificates( _
   ByVal certificateSubIdPattern As String, _
   ByVal mustExist As Boolean, _
   ByVal updateTrustedPeerCertificates As Boolean _
) As Integer

'Usage
 
Dim instance As IEasyUAClientServerApplication
Dim certificateSubIdPattern As String
Dim mustExist As Boolean
Dim updateTrustedPeerCertificates As Boolean
Dim value As Integer
 
value = instance.RemoveOwnCertificates(certificateSubIdPattern, mustExist, updateTrustedPeerCertificates)

int RemoveOwnCertificates( 
   string certificateSubIdPattern,
   bool mustExist,
   bool updateTrustedPeerCertificates
)

int RemoveOwnCertificates( 
   String^ certificateSubIdPattern,
   bool mustExist,
   bool updateTrustedPeerCertificates
)

Parameters

certificateSubIdPattern: The match pattern for the certificate sub-ids. Normally an empty string.
mustExist: Determines whether the certificate must be present in the certificate store.
updateTrustedPeerCertificates: Determines whether the trusted peers certificate store will also be updated.

Return Value

Returns the number of certificates that have been removed.

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

If the mustExist is true, the own certificate must exist in the certificate store prior to the operation, otherwise an error is reported.

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
CreateOwnCertificate Method
FindOwnCertificate Method

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