OPC Studio User's Guide and Reference
ListAllDataSetWriterLocators Method (IUAReadOnlyPubSubConfigurationExtension)



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub.Configuration.Extensions Namespace > IUAReadOnlyPubSubConfigurationExtension Class : ListAllDataSetWriterLocators Method
OPC UA PubSub configuration (read-only).
Gets locators of all dataset writers in the PubSub configuration.
Syntax
'Declaration
 
<ExtensionAttribute()>
<ElementsNotNullAttribute()>
<NotNullAttribute()>
Public Shared Function ListAllDataSetWriterLocators( _
   ByVal readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration _
) As UADataSetWriterLocator()
'Usage
 
Dim readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration
Dim value() As UADataSetWriterLocator
 
value = IUAReadOnlyPubSubConfigurationExtension.ListAllDataSetWriterLocators(readOnlyPubSubConfiguration)
[Extension()]
[ElementsNotNull()]
[NotNull()]
public static UADataSetWriterLocator[] ListAllDataSetWriterLocators( 
   IUAReadOnlyPubSubConfiguration readOnlyPubSubConfiguration
)
[Extension()]
[ElementsNotNull()]
[NotNull()]
public:
static array<UADataSetWriterLocator^>^ ListAllDataSetWriterLocators( 
   IUAReadOnlyPubSubConfiguration^ readOnlyPubSubConfiguration
) 

Parameters

readOnlyPubSubConfiguration
OPC UA PubSub configuration (read-only).

Return Value

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

Remarks

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

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