OPC Studio User's Guide and Reference
GetPublishedDataSetSourceElement Method (IUAReadOnlyPubSubConfiguration)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub.Configuration Namespace > IUAReadOnlyPubSubConfiguration Interface : GetPublishedDataSetSourceElement Method
The name of the published dataset.

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

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).

Gets the published dataset source element for a specified published dataset.
Syntax
'Declaration
 
<CanBeNullAttribute()>
Function GetPublishedDataSetSourceElement( _
   ByVal publishedDataSetName As String, _
   ByVal dataSetFolderPath As IReadOnlyList(Of String) _
) As UAPublishedDataSetSourceElement
'Usage
 
Dim instance As IUAReadOnlyPubSubConfiguration
Dim publishedDataSetName As String
Dim dataSetFolderPath As IReadOnlyList(Of String)
Dim value As UAPublishedDataSetSourceElement
 
value = instance.GetPublishedDataSetSourceElement(publishedDataSetName, dataSetFolderPath)

Parameters

publishedDataSetName
The name of the published dataset.

The value of this parameter cannot 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).

Return Value

Returns the published dataset source element.

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

Exceptions
ExceptionDescription

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.

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.

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

See Also