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



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugTemplateDefinition Class : MetadataDictionary Property
Contains the metadata for each Sparkplug metric defined in the template.
Syntax
'Declaration
 
<JetBrains.Annotations.NotNullAttribute()>
Public ReadOnly Property MetadataDictionary As StringSparkplugMetadataDictionary
'Usage
 
Dim instance As SparkplugTemplateDefinition
Dim value As StringSparkplugMetadataDictionary
 
value = instance.MetadataDictionary
[JetBrains.Annotations.NotNull()]
public StringSparkplugMetadataDictionary MetadataDictionary {get;}
[JetBrains.Annotations.NotNull()]
public:
property StringSparkplugMetadataDictionary^ MetadataDictionary {
   StringSparkplugMetadataDictionary^ 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

This is a dictionary where the key is the string that is the name of the metric in the template, and the value is the metadata for that metric (SparkplugMetadata).

The metadata defines the datatype and optionally other characteristics of the metric.

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