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



OpcLabs.EasyOpcUA Assembly > OpcLabs.EasyOpc.UA.PubSub.Configuration.Extensions Namespace > IUAReadOnlyPubSubConfigurationExtension Class : ListAllConnectionDataSetWriterLocators Method
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).

The name of the PubSub connection.

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

Gets locators of all dataset writers on specified PubSub connection.
Syntax
'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function ListAllConnectionDataSetWriterLocators( _
   ByVal readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration, _
   ByVal pubSubConnectionName As String _
) As UADataSetWriterLocator()
'Usage
 
Dim readOnlyPubSubConfiguration As IUAReadOnlyPubSubConfiguration
Dim pubSubConnectionName As String
Dim value() As UADataSetWriterLocator
 
value = IUAReadOnlyPubSubConfigurationExtension.ListAllConnectionDataSetWriterLocators(readOnlyPubSubConfiguration, pubSubConnectionName)
[Extension()]
[NotNull()]
public static UADataSetWriterLocator[] ListAllConnectionDataSetWriterLocators( 
   IUAReadOnlyPubSubConfiguration readOnlyPubSubConfiguration,
   string pubSubConnectionName
)

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

pubSubConnectionName
The name of the PubSub connection.

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

Remarks

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

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

See Also