ListCertificateTypeElements Method (IEasyUAClientServerApplicationExtension)

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 available for an application instance.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<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()]
[NotNull()]
public static UACertificateTypeElementCollection ListCertificateTypeElements( 
   IEasyUAClientServerApplication application,
   UAEndpointDescriptor gdsEndpointDescriptor
)

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

Parameters

application

The OPC UA client/server application object that will perform the operation.

In client applications, this is typically obtained by calling System.IServiceProvider.GetService(System.Type) on the OpcLabs.EasyOpc.UA.IEasyUAClient (EasyUAClient object) with the type of OpcLabs.EasyOpc.UA.Application.IEasyUAClientServerApplication as an argument.

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

gdsEndpointDescriptor

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

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

Return Value

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

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

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.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

Documentation Home, Send Documentation Feedback. Technical Support