SearchPublishedDataSet(IUAReadOnlyPubSubConfiguration,IReadOnlyList<String>,String) Method

Searches for the published dataset in the specified dataset folder and its subfolders (recursively), and returns the dataset folder path it is in.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<CanBeNullAttribute()>
Public Overloads Shared Function SearchPublishedDataSet( _
   ByVal readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration, _
   ByVal dataSetFolderPath As IReadOnlyList(Of String), _
   ByVal publishedDataSetName As String _
) As String()

'Usage
 
Dim readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration
Dim dataSetFolderPath As IReadOnlyList(Of String)
Dim publishedDataSetName As String
Dim value() As String
 
value = IUAReadOnlyPubSubConfigurationExtension.SearchPublishedDataSet(readOnlyPubSubConfiguration, dataSetFolderPath, publishedDataSetName)

[Extension()]
[CanBeNull()]
public static string[] SearchPublishedDataSet( 
   IUAReadOnlyPubSubConfiguration readOnlyPubSubConfiguration,
   IReadOnlyList<string> dataSetFolderPath,
   string publishedDataSetName
)

[Extension()]
[CanBeNull()]
public:
static array<String^>^ SearchPublishedDataSet( 
   IUAReadOnlyPubSubConfiguration^ readOnlyPubSubConfiguration,
   IReadOnlyList<String^>^ dataSetFolderPath,
   String^ publishedDataSetName
)

Parameters

readOnlyPubSubConfiguration

OPC UA PubSub configuration (read-only).

This is typically obtained by calling OpcLabs.EasyOpc.UA.PubSub.InformationModel.EasyUAPublishSubscribeClientCore.AccessReadOnlyConfiguration, OpcLabs.EasyOpc.UA.PubSub.InformationModel.Extensions.IEasyUAPublishSubscribeClientExtension.AccessOrLoadReadOnlyConfiguration or OpcLabs.EasyOpc.UA.PubSub.InformationModel.Extensions.IEasyUAPublishSubscribeClientExtension.AccessOrLoadReadOnlyConfiguration.

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

dataSetFolderPath

A path to the folder that contains the published dataset.

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

publishedDataSetName

The name of the published dataset.

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

Return Value

Returns an array of dataset folder names that represents the dataset folder path of the dataset folder where the published dataset with name resides. Returns null if the specified published dataset name does not exist in the dataset folder specified by or its subfolders (recursively).

This method can return 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

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

IUAReadOnlyPubSubConfigurationExtension Class
IUAReadOnlyPubSubConfigurationExtension Members
Overload List

Documentation Home, Send Documentation Feedback. Technical Support