LoadReadOnlyConfigurationFromFileNode Method (

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

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function LoadReadOnlyConfigurationFromFileNode( _
   ByVal endpointDescriptor As Object _
) As _UAReadOnlyPubSubConfiguration

'Usage
 
Dim instance As _EasyUAPublishSubscribeClient
Dim endpointDescriptor As Object
Dim value As _UAReadOnlyPubSubConfiguration
 
value = instance.LoadReadOnlyConfigurationFromFileNode(endpointDescriptor)

[NotNull()]
_UAReadOnlyPubSubConfiguration LoadReadOnlyConfigurationFromFileNode( 
   object endpointDescriptor
)

[NotNull()]
_UAReadOnlyPubSubConfiguration^ LoadReadOnlyConfigurationFromFileNode( 
   Object^ endpointDescriptor
)

Parameters

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

_EasyUAPublishSubscribeClient Interface
_EasyUAPublishSubscribeClient Members

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.