RemoveOwnCertificatesOrCertificatePack Method (IEasyUAClientServerApplication)

Removes the own certificates or certificate pack the application is currently configured to use.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Function RemoveOwnCertificatesOrCertificatePack( _
   ByVal certificateSubIdPattern As String, _
   ByVal certificateTypeId As UANodeId, _
   ByVal mustExist As Boolean, _
   ByVal updateTrustedPeerCertificates As Boolean _
) As Integer

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

int RemoveOwnCertificatesOrCertificatePack( 
   string certificateSubIdPattern,
   UANodeId certificateTypeId,
   bool mustExist,
   bool updateTrustedPeerCertificates
)

int RemoveOwnCertificatesOrCertificatePack( 
   String^ certificateSubIdPattern,
   UANodeId^ certificateTypeId,
   bool mustExist,
   bool updateTrustedPeerCertificates
)

Parameters

certificateSubIdPattern

The match pattern for the certificate sub-ids. Normally an empty string.

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

certificateTypeId

The certificate type Id, or null (Nothing in Visual Basic) for certificate pack.

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

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

When certificate pack is used, this method operates on certificates with certificate type Ids given by PackCertificateTypeIds.

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

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
CreateOwnCertificateOrCertificatePack Method
FindOwnCertificate Method
PackCertificateTypeIds Property

Documentation Home, Send Documentation Feedback. Technical Support