GetPublishSubscribeElement Method (IEasyUAPublishSubscribeClient)

The endpoint descriptor of the OPC UA server containing the PubSub information 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).

Gets the publish-subscribe object element in the PubSub information model.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function GetPublishSubscribeElement( _
   ByVal endpointDescriptor As UAEndpointDescriptor _
) As UAPublishSubscribeElement

'Usage
 
Dim instance As IEasyUAPublishSubscribeClient
Dim endpointDescriptor As UAEndpointDescriptor
Dim value As UAPublishSubscribeElement
 
value = instance.GetPublishSubscribeElement(endpointDescriptor)

[NotNull()]
UAPublishSubscribeElement GetPublishSubscribeElement( 
   UAEndpointDescriptor endpointDescriptor
)

[NotNull()]
UAPublishSubscribeElement^ GetPublishSubscribeElement( 
   UAEndpointDescriptor^ endpointDescriptor
)

Parameters

endpointDescriptor

The endpoint descriptor of the OPC UA server containing the PubSub information model.

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

Return Value

Returns the publish-subscribe object element.

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

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.

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

IEasyUAPublishSubscribeClient Interface
IEasyUAPublishSubscribeClient Members

Documentation Home, Send Documentation Feedback. Technical Support