Connectivity Software User's Guide and Reference
FindSystemBySystemId Method



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug.System Namespace > EasySparkplugInfrastructure Class : FindSystemBySystemId Method
The Sparkplug system ID.

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

Finds a Sparkplug system by its system Id.
Syntax
'Declaration
 
<JetBrains.Annotations.CanBeNullAttribute()>
Public Function FindSystemBySystemId( _
   ByVal systemId As String _
) As EasySparkplugSystem
'Usage
 
Dim instance As EasySparkplugInfrastructure
Dim systemId As String
Dim value As EasySparkplugSystem
 
value = instance.FindSystemBySystemId(systemId)
[JetBrains.Annotations.CanBeNull()]
public EasySparkplugSystem FindSystemBySystemId( 
   string systemId
)
[JetBrains.Annotations.CanBeNull()]
public:
EasySparkplugSystem^ FindSystemBySystemId( 
   String^ systemId
) 

Parameters

systemId
The Sparkplug system ID.

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

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

Remarks

 

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

See Also