CreateSystem(String,SparkplugConnectionDescriptor) Method

Creates a new Sparkplug system object with the specified system ID and connection descriptor, and adds it to the infrastructure.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Function CreateSystem( _
   ByVal systemId As String, _
   ByVal connectionDescriptor As SparkplugConnectionDescriptor _
) As EasySparkplugSystem

'Usage
 
Dim instance As EasySparkplugInfrastructure
Dim systemId As String
Dim connectionDescriptor As SparkplugConnectionDescriptor
Dim value As EasySparkplugSystem
 
value = instance.CreateSystem(systemId, connectionDescriptor)

[JetBrains.Annotations.NotNull()]
public EasySparkplugSystem CreateSystem( 
   string systemId,
   SparkplugConnectionDescriptor connectionDescriptor
)

[JetBrains.Annotations.NotNull()]
public:
EasySparkplugSystem^ CreateSystem( 
   String^ systemId,
   SparkplugConnectionDescriptor^ connectionDescriptor
)

Parameters

systemId: The Sparkplug system ID.
The value of this parameter cannot be null (Nothing in Visual Basic).
connectionDescriptor: The Sparkplug connection descriptor.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns the created Sparkplug system object.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. 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.

System.ArgumentException

One of the arguments provided to a method is not valid.

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

The newly created system uses EasySparkplugSystem.DefaultSparkplugVersion as its Sparkplug version.

This method throws System.ArgumentException when a system with the specified systemId already exists in the infrastructure.

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
DestroySystem Method

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.