GetExtensionFieldValue Method (_UAReadOnlyPubSubConfiguration)

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

Syntax

[CanBeNull()]
object GetExtensionFieldValue( 
   string publishedDataSetName,
   object dataSetFolderPath,
   object extensionFieldQualifiedName
)

[CanBeNull()]
Object^ GetExtensionFieldValue( 
   String^ publishedDataSetName,
   Object^ dataSetFolderPath,
   Object^ extensionFieldQualifiedName
)

'Declaration
 
<CanBeNullAttribute()>
Function GetExtensionFieldValue( _
   ByVal publishedDataSetName As String, _
   ByVal dataSetFolderPath As Object, _
   ByVal extensionFieldQualifiedName As Object _
) As Object

'Usage
 
Dim instance As _UAReadOnlyPubSubConfiguration
Dim publishedDataSetName As String
Dim dataSetFolderPath As Object
Dim extensionFieldQualifiedName As Object
Dim value As Object
 
value = instance.GetExtensionFieldValue(publishedDataSetName, dataSetFolderPath, extensionFieldQualifiedName)

Parameters

publishedDataSetName

The name of the published dataset.

The value of this parameter can be null (Nothing in Visual Basic).

dataSetFolderPath

An optional path to the folder that contains the published dataset.

The value of this parameter can be null (Nothing in Visual Basic).

The individual elements of the parameter value cannot be null (Nothing in Visual Basic).

extensionFieldQualifiedName

The qualified name of the extension field.

Because the OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName has an implicit conversion from System.String, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use a string (representing the expanded text of the qualified name) in place of this parameter, and the corresponding OPC UA qualified name will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can use the OpcLabs.EasyOpc.UA.AddressSpace.UAQualifiedName.UAQualifiedName Constructor(String) constructor instead.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

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

This method can return null (Nothing in Visual Basic).

Exceptions

Exception	Description
System.Exception	An error has occurred during application execution.
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.

Remarks

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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

_UAReadOnlyPubSubConfiguration Interface
_UAReadOnlyPubSubConfiguration Members

Documentation Home, Send 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.