SearchPublishedDataSet Method (_UAReadOnlyPubSubConfiguration)

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
 
<CanBeNullAttribute()>
Function SearchPublishedDataSet( _
   ByVal dataSetFolderPath As Object, _
   ByVal publishedDataSetName As String _
) As Object()

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

[CanBeNull()]
object[] SearchPublishedDataSet( 
   object dataSetFolderPath,
   string publishedDataSetName
)

[CanBeNull()]
array<Object^>^ SearchPublishedDataSet( 
   Object^ dataSetFolderPath,
   String^ publishedDataSetName
)

Parameters

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 can 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
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 Documentation Feedback. Technical Support