Connectivity Software User's Guide and Reference
PayloadElementCollection Property



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugPayload Class : PayloadElementCollection Property
A read-only collection of Sparkplug payload elements, which are key-value pairs of metric names and metric elements.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public ReadOnly Property PayloadElementCollection As ISparkplugPayloadElementReadOnlyCollection
'Usage
 
Dim instance As SparkplugPayload
Dim value As ISparkplugPayloadElementReadOnlyCollection
 
value = instance.PayloadElementCollection
[JetBrains.Annotations.NotNull()]
public ISparkplugPayloadElementReadOnlyCollection PayloadElementCollection {get;}
[JetBrains.Annotations.NotNull()]
public:
property ISparkplugPayloadElementReadOnlyCollection^ PayloadElementCollection {
   ISparkplugPayloadElementReadOnlyCollection^ get();
}

Property Value

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

Remarks

The order of the elements may have significance if there are multiple elements for the same metric (e.g. with transient or historical data).

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

 

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