ListCertificateTypeElements Method (AbstractEasyUAClientServerApplication)

The GDS endpoint acting as OPC UA certificate manager (CM).

Because the OpcLabs.EasyOpc.UA.UAEndpointDescriptor has implicit conversions from System.String and System.Uri, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the endpoint URL, or a so-called OPC UA endpoint descriptor string), or a System.Uri object, in place of this parameter, and the corresponding endpoint descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the FromString or FromUri static method instead.

If you are using OPC Wizard (for server development), an implicit conversion from OpcLabs.EasyOpc.UA.EasyUAServerCore can be used in the same way to simply pass the server object in place of this parameter, which will use its OpcLabs.EasyOpc.UA.EasyUAServerCore.EffectiveServerDescriptor property for the connection.

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

Retrieves certificate type elements for the certificate types available for a given application store kind.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function ListCertificateTypeElements( _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor, _
   ByVal applicationStoreKind As PkiApplicationStoreKind _
) As UACertificateTypeElementCollection

'Usage
 
Dim instance As AbstractEasyUAClientServerApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim applicationStoreKind As PkiApplicationStoreKind
Dim value As UACertificateTypeElementCollection
 
value = instance.ListCertificateTypeElements(gdsEndpointDescriptor, applicationStoreKind)

public UACertificateTypeElementCollection ListCertificateTypeElements( 
   UAEndpointDescriptor gdsEndpointDescriptor,
   PkiApplicationStoreKind applicationStoreKind
)

public:
UACertificateTypeElementCollection^ ListCertificateTypeElements( 
   UAEndpointDescriptor^ gdsEndpointDescriptor,
   PkiApplicationStoreKind applicationStoreKind
)

Parameters

gdsEndpointDescriptor

The GDS endpoint acting as OPC UA certificate manager (CM).

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

applicationStoreKind

The kind (purpose) of PKI application store, such as Instance, User, or HTTPS.

Return Value

Returns a collection of certificate type elements for certificate types available in the certificate manager for the given application store kind.

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

The individual elements of the returned value are never null (Nothing in Visual Basic).

Exceptions

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. 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.

Exception

Description

System.ArgumentException

One of the arguments provided to a method is not valid.

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

When gdsEndpointDescriptor is null, the method returns a collection of certificate type elements that represents the "built-in" certificate types described in the OPC UA specification.

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

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