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



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub.Configuration Namespace > IUAReadOnlyPubSubConfiguration Interface : HasDataSetFolder Method
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).

The name of the dataset folder.

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

Determines whether the specified dataset folder exists.
Syntax
'Declaration
 
Function HasDataSetFolder( _
   ByVal dataSetFolderPath As IReadOnlyList(Of String), _
   ByVal dataSetFolderName As String _
) As Boolean
'Usage
 
Dim instance As IUAReadOnlyPubSubConfiguration
Dim dataSetFolderPath As IReadOnlyList(Of String)
Dim dataSetFolderName As String
Dim value As Boolean
 
value = instance.HasDataSetFolder(dataSetFolderPath, dataSetFolderName)

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

dataSetFolderName
The name of the dataset folder.

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

Return Value

Returns true if the dataset folder named dataSetFolderName exists (directly) under the dataset folder specified by the dataSetFolderPath; returns false otherwise.
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