Connectivity Software User's Guide and Reference
MetadataDictionary Property (SparkplugPayload)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugPayload Class : MetadataDictionary Property
A read-only dictionary of Sparkplug metadata for metrics contained in the payload, keyed by metric name.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public ReadOnly Property MetadataDictionary As IStringSparkplugMetadataReadOnlyDictionary
'Usage
 
Dim instance As SparkplugPayload
Dim value As IStringSparkplugMetadataReadOnlyDictionary
 
value = instance.MetadataDictionary
[JetBrains.Annotations.NotNull()]
public IStringSparkplugMetadataReadOnlyDictionary MetadataDictionary {get;}
[JetBrains.Annotations.NotNull()]
public:
property IStringSparkplugMetadataReadOnlyDictionary^ MetadataDictionary {
   IStringSparkplugMetadataReadOnlyDictionary^ get();
}

Property Value

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

The individual elements of the property value cannot be null (Nothing in Visual Basic).

Remarks

Metadata is generally optional. When there is no metadata for a metric, there is no entry in this dictionary for the key with the metric name. An entry with null metadata value is not allowed.

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