ListAllDataSetWriterLocators Method (IUAReadOnlyPubSubConfigurationExtension)

Gets locators of all dataset writers in the PubSub configuration.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<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()]
[NotNull()]
public static UADataSetWriterLocator[] ListAllDataSetWriterLocators( 
   IUAReadOnlyPubSubConfiguration readOnlyPubSubConfiguration
)

[Extension()]
[NotNull()]
public:
static array<UADataSetWriterLocator^>^ ListAllDataSetWriterLocators( 
   IUAReadOnlyPubSubConfiguration^ readOnlyPubSubConfiguration
)

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

Return Value

Returns an array of dataset writer locators.

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.

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.

Remarks

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

PubSub connection name,
writer group name, and
dataset writer name.

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

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.