ListPublishedDataSetNames Method (IUAReadOnlyPubSubConfiguration)

Gets names of published datasets in a specified dataset folder.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Function ListPublishedDataSetNames( _
   ByVal dataSetFolderPath As IReadOnlyList(Of String), _
   ByVal recursive As Boolean _
) As StringCollection

'Usage
 
Dim instance As IUAReadOnlyPubSubConfiguration
Dim dataSetFolderPath As IReadOnlyList(Of String)
Dim recursive As Boolean
Dim value As StringCollection
 
value = instance.ListPublishedDataSetNames(dataSetFolderPath, recursive)

[NotNull()]
StringCollection ListPublishedDataSetNames( 
   IReadOnlyList<string> dataSetFolderPath,
   bool recursive
)

[NotNull()]
StringCollection^ ListPublishedDataSetNames( 
   IReadOnlyList<String^>^ dataSetFolderPath,
   bool recursive
)

Parameters

dataSetFolderPath

A path to the dataset folder.

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

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

recursive

Determines whether the published datasets will be taken from the subfolders as well, recursively.

Return Value

Returns a collection of published dataset names.

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.

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.