OPC Studio User's Guide and Reference
AccessOrLoadReadOnlyConfiguration(IEasyUAPublishSubscribeClient,UAEndpointDescriptor) Method



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub.InformationModel.Extensions Namespace > IEasyUAPublishSubscribeClientExtension Class > AccessOrLoadReadOnlyConfiguration Method : AccessOrLoadReadOnlyConfiguration(IEasyUAPublishSubscribeClient,UAEndpointDescriptor) Method
A client for OPC UA PubSub information model.
The endpoint descriptor of the OPC UA server containing the PubSub information model.
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
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Overloads Shared Function AccessOrLoadReadOnlyConfiguration( _
   ByVal publishSubscribeClient As IEasyUAPublishSubscribeClient, _
   ByVal endpointDescriptor As UAEndpointDescriptor _
) As IUAReadOnlyPubSubConfiguration
'Usage
 
Dim publishSubscribeClient As IEasyUAPublishSubscribeClient
Dim endpointDescriptor As UAEndpointDescriptor
Dim value As IUAReadOnlyPubSubConfiguration
 
value = IEasyUAPublishSubscribeClientExtension.AccessOrLoadReadOnlyConfiguration(publishSubscribeClient, endpointDescriptor)

Parameters

publishSubscribeClient
A client for OPC UA PubSub information model.
endpointDescriptor
The endpoint descriptor of the OPC UA server containing the PubSub information model.

Return Value

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

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.

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

See Also