ListCertificateTypeElements Method (IEasyUAClientServerApplicationExtension)

Retrieves certificate type elements available for an application instance.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Public Shared Function ListCertificateTypeElements( _
   ByVal application As IEasyUAClientServerApplication, _
   ByVal gdsEndpointDescriptor As UAEndpointDescriptor _
) As UACertificateTypeElementCollection

'Usage
 
Dim application As IEasyUAClientServerApplication
Dim gdsEndpointDescriptor As UAEndpointDescriptor
Dim value As UACertificateTypeElementCollection
 
value = IEasyUAClientServerApplicationExtension.ListCertificateTypeElements(application, gdsEndpointDescriptor)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public static UACertificateTypeElementCollection ListCertificateTypeElements( 
   IEasyUAClientServerApplication application,
   UAEndpointDescriptor gdsEndpointDescriptor
)

[Extension()]
[ElementsNotNull()]
[NotNull()]
public:
static UACertificateTypeElementCollection^ ListCertificateTypeElements( 
   IEasyUAClientServerApplication^ application,
   UAEndpointDescriptor^ gdsEndpointDescriptor
)

Parameters

application: The OPC UA client/server application object that will perform the operation.
gdsEndpointDescriptor: The GDS endpoint acting as OPC UA certificate manager (CM).

Return Value

Returns a collection of certificate type Ids available in the certificate manager for an application instance.

Exceptions

Exception Description

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

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

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

IEasyUAClientServerApplicationExtension Class
IEasyUAClientServerApplicationExtension Members

Send Documentation Feedback. Technical Support