FindWriterGroupElement Method (IUAReadOnlyPubSubConfiguration)

Finds a writer group by its name.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<CanBeNullAttribute()>
Function FindWriterGroupElement( _
   ByVal pubSubConnectionName As String, _
   ByVal writerGroupName As String _
) As UAWriterGroupElement

'Usage
 
Dim instance As IUAReadOnlyPubSubConfiguration
Dim pubSubConnectionName As String
Dim writerGroupName As String
Dim value As UAWriterGroupElement
 
value = instance.FindWriterGroupElement(pubSubConnectionName, writerGroupName)

[CanBeNull()]
UAWriterGroupElement FindWriterGroupElement( 
   string pubSubConnectionName,
   string writerGroupName
)

[CanBeNull()]
UAWriterGroupElement^ FindWriterGroupElement( 
   String^ pubSubConnectionName,
   String^ writerGroupName
)

Parameters

pubSubConnectionName: The name of the PubSub connection.
The value of this parameter cannot be null (Nothing in Visual Basic).
writerGroupName: The name of the writer group.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns the writer group element, if found; returns null otherwise.

Because the UAWriterGroupElement has an implicit conversion to OpcLabs.EasyOpc.UA.PubSub.UAWriterGroupDescriptor, in languages that support implicit conversion operators (such as C# or VB.NET), you can simply use the returned UAWriterGroupElement (from PubSub configuration) in any place where OpcLabs.EasyOpc.UA.PubSub.UAWriterGroupDescriptor is expected as input, and the corresponding OPC UA PubSub writer group descriptor will be constructed automatically. When the implicit conversion operators are not supported (such as with Python.NET), you can convert a UAWriterGroupElement to OpcLabs.EasyOpc.UA.PubSub.UAWriterGroupDescriptor using the UAWriterGroupElement.ToUAWriterGroupDescriptor static method instead.

This method can return 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.
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.

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.

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

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