AccessSecurityKeyService Method (EasyUAPublishSubscribeClientCore)

The endpoint descriptor of the OPC UA server containing the PubSub Security Key Service (SKS) model.

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 OpcLabs.EasyOpc.UA.UAEndpointDescriptor.FromString or OpcLabs.EasyOpc.UA.UAEndpointDescriptor.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 cannot be null (Nothing in Visual Basic).

Gives access to PubSub security key service (SKS) provided by the specified OPC UA server.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function AccessSecurityKeyService( _
   ByVal endpointDescriptor As UAEndpointDescriptor _
) As IUAPubSubSecurityKeyService

'Usage
 
Dim instance As EasyUAPublishSubscribeClientCore
Dim endpointDescriptor As UAEndpointDescriptor
Dim value As IUAPubSubSecurityKeyService
 
value = instance.AccessSecurityKeyService(endpointDescriptor)

public IUAPubSubSecurityKeyService AccessSecurityKeyService( 
   UAEndpointDescriptor endpointDescriptor
)

public:
IUAPubSubSecurityKeyService^ AccessSecurityKeyService( 
   UAEndpointDescriptor^ endpointDescriptor
)

Parameters

endpointDescriptor

The endpoint descriptor of the OPC UA server containing the PubSub Security Key Service (SKS) model.

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

Return Value

Returns an interface that provides read-only access to PubSub security key service (SKS) .

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

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

Remarks

You can use the HasConfigurationModel method to determine whether the given server provides a PubSub Security Key Service (SKS) model. Operations on the returned OpcLabs.EasyOpc.UA.PubSub.SecurityKeyService.IUAReadOnlyPubSubSecurityKeyService will fail if it does not.

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

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