FindSystemByConnectionDescriptor(SparkplugConnectionDescriptor,SparkplugVersions) Method

Finds a Sparkplug system by its connection descriptor and Sparkplug version.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
Public Overloads Function FindSystemByConnectionDescriptor( _
   ByVal connectionDescriptor As SparkplugConnectionDescriptor, _
   ByVal sparkplugVersion As SparkplugVersions _
) As EasySparkplugSystem

'Usage
 
Dim instance As EasySparkplugInfrastructure
Dim connectionDescriptor As SparkplugConnectionDescriptor
Dim sparkplugVersion As SparkplugVersions
Dim value As EasySparkplugSystem
 
value = instance.FindSystemByConnectionDescriptor(connectionDescriptor, sparkplugVersion)

[JetBrains.Annotations.CanBeNull()]
public EasySparkplugSystem FindSystemByConnectionDescriptor( 
   SparkplugConnectionDescriptor connectionDescriptor,
   SparkplugVersions sparkplugVersion
)

[JetBrains.Annotations.CanBeNull()]
public:
EasySparkplugSystem^ FindSystemByConnectionDescriptor( 
   SparkplugConnectionDescriptor^ connectionDescriptor,
   SparkplugVersions sparkplugVersion
)

Parameters

connectionDescriptor: The Sparkplug connection descriptor.
The value of this parameter cannot be null (Nothing in Visual Basic).
sparkplugVersion: The Sparkplug version used by the system.

Return Value

Returns the Sparkplug system object found, or null where no Sparkplug system satisfying the criteria has been found.

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.

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.

Remarks

If the sparkplugVersion is OpcLabs.EasySparkplug.SparkplugVersions.None, the method searches for a system with any Sparkplug version. If multiple such systems exist, the first one found is returned (the order of systems is not defined).

If the sparkplugVersion is OpcLabs.EasySparkplug.SparkplugVersions.None, the method searches for a system with precisely the specified Sparkplug version.

Sparkplug is a trademark of Eclipse Foundation, Inc. "MQTT" is a trademark of the OASIS Open standards consortium. Other related terms are trademarks of their respective owners. Any use of these terms on this site is for descriptive purposes only and does not imply any sponsorship, endorsement or affiliation.

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

EasySparkplugInfrastructure Class
EasySparkplugInfrastructure Members
Overload List

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.