ListDataSetWriterLocators Method (IUAReadOnlyPubSubConfiguration)

Gets the dataset writer locators for the specified published dataset.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function ListDataSetWriterLocators( _
   ByVal publishedDataSetName As String, _
   ByVal dataSetFolderPath As IReadOnlyList(Of String) _
) As UADataSetWriterLocator()

'Usage
 
Dim instance As IUAReadOnlyPubSubConfiguration
Dim publishedDataSetName As String
Dim dataSetFolderPath As IReadOnlyList(Of String)
Dim value() As UADataSetWriterLocator
 
value = instance.ListDataSetWriterLocators(publishedDataSetName, dataSetFolderPath)

[NotNull()]
UADataSetWriterLocator[] ListDataSetWriterLocators( 
   string publishedDataSetName,
   IReadOnlyList<string> dataSetFolderPath
)

[NotNull()]
array<UADataSetWriterLocator^>^ ListDataSetWriterLocators( 
   String^ publishedDataSetName,
   IReadOnlyList<String^>^ 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 dataset folder.

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 an array of the dataset writer locators.

This method never returns null (Nothing in Visual Basic).

The individual elements of the returned value are never null (Nothing in Visual Basic).

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.

Remarks

In this context, the dataset writer locator is a tuple consisting of

PubSub connection name,
writer group name, and
dataset writer name.

This method complements the ability to obtain UADataSetWriterElement.PublishedDataSetName from the UADataSetWriterElement returned by FindDataSetWriterElement. It would be possible to obtain the data set writer locators using other methods on IUAReadOnlyPubSubConfiguration, but it would be extremely ineffective, especially in case of OpcLabs.EasyOpc.UA.PubSub.Configuration.Implementation.UAPubSubClientConfiguration, as references (of type OpcLabs.EasyOpc.UA.AddressSpace.Standard.UAReferenceTypeIds.DataSetToWriter) exist in the address space to allow the data set writer be found easily.

The returned locators are guaranteed to be unique.

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

IUAReadOnlyPubSubConfiguration Interface
IUAReadOnlyPubSubConfiguration 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.