HasConfigurationFileNode Method (IEasyUAPublishSubscribeClientExtension)

Determines whether there is a node representing the PubSub configuration as an OPC UA file object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Shared Function HasConfigurationFileNode( _
   ByVal publishSubscribeClient As IEasyUAPublishSubscribeClient, _
   ByVal endpointDescriptor As UAEndpointDescriptor _
) As Boolean

'Usage
 
Dim publishSubscribeClient As IEasyUAPublishSubscribeClient
Dim endpointDescriptor As UAEndpointDescriptor
Dim value As Boolean
 
value = IEasyUAPublishSubscribeClientExtension.HasConfigurationFileNode(publishSubscribeClient, endpointDescriptor)

[Extension()]
public static bool HasConfigurationFileNode( 
   IEasyUAPublishSubscribeClient publishSubscribeClient,
   UAEndpointDescriptor endpointDescriptor
)

[Extension()]
public:
static bool HasConfigurationFileNode( 
   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 true when the target OPC UA server contains a node with a PubSub configuration file object; returns false otherwise.

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 detects 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. Technical support: Online Forums, FAQ.