GetExtensionFieldValue Method (IUAReadOnlyPubSubConfigurationExtension)

Gets the value of an extension field in specified published dataset.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<CanBeNullAttribute()>
Public Shared Function GetExtensionFieldValue( _
   ByVal readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration, _
   ByVal publishedDataSetName As String, _
   ByVal dataSetFolderPath As IReadOnlyList(Of String), _
   ByVal extensionFieldQualifiedName As UAQualifiedName _
) As Object

'Usage
 
Dim readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration
Dim publishedDataSetName As String
Dim dataSetFolderPath As IReadOnlyList(Of String)
Dim extensionFieldQualifiedName As UAQualifiedName
Dim value As Object
 
value = IUAReadOnlyPubSubConfigurationExtension.GetExtensionFieldValue(readOnlyPubSubConfiguration, publishedDataSetName, dataSetFolderPath, extensionFieldQualifiedName)

[Extension()]
[CanBeNull()]
public static object GetExtensionFieldValue( 
   IUAReadOnlyPubSubConfiguration readOnlyPubSubConfiguration,
   string publishedDataSetName,
   IReadOnlyList<string> dataSetFolderPath,
   UAQualifiedName extensionFieldQualifiedName
)

[Extension()]
[CanBeNull()]
public:
static Object^ GetExtensionFieldValue( 
   IUAReadOnlyPubSubConfiguration^ readOnlyPubSubConfiguration,
   String^ publishedDataSetName,
   IReadOnlyList<String^>^ dataSetFolderPath,
   UAQualifiedName^ extensionFieldQualifiedName
)

Parameters

readOnlyPubSubConfiguration: OPC UA PubSub configuration (read-only).
publishedDataSetName: The name of the published dataset.
dataSetFolderPath: An optional path to the folder that contains the published dataset.
extensionFieldQualifiedName: The qualified name of the extension field.

Return Value

Returns an object that is a value of the specified extension field.

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.
OpcLabs.EasyOpc.UA.OperationModel.UALogicalException	There is a logical error in the OPC UA operation. 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.

OpcLabs.EasyOpc.UA.OperationModel.UALogicalException

There is a logical error in the OPC UA operation.

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.

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

IUAReadOnlyPubSubConfigurationExtension Class
IUAReadOnlyPubSubConfigurationExtension Members

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