AccessOrLoadReadOnlyConfiguration Method (_EasyUAPublishSubscribeClient)

Provides read-only access to the PubSub configuration provided by an OPC UA server, either by using the PubSub configuration model, or optionally by loading it from an OPC UA file object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function AccessOrLoadReadOnlyConfiguration( _
   ByVal endpointDescriptor As Object, _
   ByVal pubSubConfigurationAccessMethod As UAPubSubConfigurationAccessMethod _
) As _UAReadOnlyPubSubConfiguration

'Usage
 
Dim instance As _EasyUAPublishSubscribeClient
Dim endpointDescriptor As Object
Dim pubSubConfigurationAccessMethod As UAPubSubConfigurationAccessMethod
Dim value As _UAReadOnlyPubSubConfiguration
 
value = instance.AccessOrLoadReadOnlyConfiguration(endpointDescriptor, pubSubConfigurationAccessMethod)

[NotNull()]
_UAReadOnlyPubSubConfiguration AccessOrLoadReadOnlyConfiguration( 
   object endpointDescriptor,
   UAPubSubConfigurationAccessMethod pubSubConfigurationAccessMethod
)

[NotNull()]
_UAReadOnlyPubSubConfiguration^ AccessOrLoadReadOnlyConfiguration( 
   Object^ endpointDescriptor,
   UAPubSubConfigurationAccessMethod pubSubConfigurationAccessMethod
)

Parameters

endpointDescriptor: The endpoint descriptor of the OPC UA server containing the PubSub information model.
pubSubConfigurationAccessMethod: Determines whether it is allowed to load the configuration from the file node in the information model, if available.

Return Value

Returns an interface that allows read-only access to the PubSub configuration.

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.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. 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.

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

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

This method optionally detects and possibly uses a PubSubConfiguration file node defined in OPC UA 1.05, or a vendor specific ConfigurationFile file node, present in servers implemented with Unified Automation (C++) toolkit.

Loading the configuration from a file node is typically faster than accessing it through individual nodes in the information model, but it only provides a one-time snapshot of the configuration.

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

_EasyUAPublishSubscribeClient Interface
_EasyUAPublishSubscribeClient Members

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