LoadReadOnlyConfigurationFromFileNode(IEasyUAPublishSubscribeClient,UAEndpointDescriptor) Method

Loads the PubSub configuration from a well-known OPC UA file object in the information model.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function LoadReadOnlyConfigurationFromFileNode( _
   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.LoadReadOnlyConfigurationFromFileNode(publishSubscribeClient, endpointDescriptor)

[Extension()]
[NotNull()]
public static IUAReadOnlyPubSubConfiguration LoadReadOnlyConfigurationFromFileNode( 
   IEasyUAPublishSubscribeClient publishSubscribeClient,
   UAEndpointDescriptor endpointDescriptor
)

[Extension()]
[NotNull()]
public:
static IUAReadOnlyPubSubConfiguration^ LoadReadOnlyConfigurationFromFileNode( 
   IEasyUAPublishSubscribeClient^ publishSubscribeClient,
   UAEndpointDescriptor^ 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 the PubSub configuration loaded from the OPC UA file object.

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.

Remarks

This method optionally 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

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