ListCertificateSubIds Method (IEasyUAClientServerApplication)

Finds all application certificate sub-ids.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.ItemNotNullAttribute()>
<JetBrains.Annotations.MustUseReturnValueAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Function ListCertificateSubIds( _
   ByVal certificateSubIdPattern As String _
) As StringSet

'Usage
 
Dim instance As IEasyUAClientServerApplication
Dim certificateSubIdPattern As String
Dim value As StringSet
 
value = instance.ListCertificateSubIds(certificateSubIdPattern)

[JetBrains.Annotations.ItemNotNull()]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
StringSet ListCertificateSubIds( 
   string certificateSubIdPattern
)

[JetBrains.Annotations.ItemNotNull()]
[JetBrains.Annotations.MustUseReturnValue()]
[JetBrains.Annotations.NotNull()]
StringSet^ ListCertificateSubIds( 
   String^ certificateSubIdPattern
)

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

Return Value

Returns a set of strings that contains sub-ids of all application certificates present in the certificate store.

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

The individual elements of the returned value are never 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

The default certificate, if present in the certificate store, is represented by an empty string in the set.

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.