Add(String,SparkplugMetricData) Method

Adds a Sparkplug metric to the payload, specifying the metric name and data.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Overloads Sub Add( _
   ByVal metricName As String, _
   ByVal metricData As SparkplugMetricData _
)

'Usage
 
Dim instance As SparkplugPayload
Dim metricName As String
Dim metricData As SparkplugMetricData
 
instance.Add(metricName, metricData)

public void Add( 
   string metricName,
   SparkplugMetricData metricData
)

public:
void Add( 
   String^ metricName,
   SparkplugMetricData^ metricData
)

Parameters

metricName: The Sparkplug metric name.
The value of this parameter cannot be null (Nothing in Visual Basic).
metricData: The Sparkplug metric data.
The value of this parameter cannot be 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

There will be no metadata for this metric in the payload.

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

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