'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function GetMetric( _
   ByVal producer As ISparkplugProducer, _
   ByVal metricName As String _
) As SparkplugMetric

'Usage
 
Dim producer As ISparkplugProducer
Dim metricName As String
Dim value As SparkplugMetric
 
value = ISparkplugProducerExtension.GetMetric(producer, metricName)

[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugMetric GetMetric( 
   ISparkplugProducer producer,
   string metricName
)

[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugMetric^ GetMetric( 
   ISparkplugProducer^ producer,
   String^ metricName
) 

Parameters

producer

The Sparkplug producer that will perform the operation.

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

metricName

The Sparkplug metric name.

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

Return Value

If the metric with the metricName does not exist in the edge node or device, this method throws OpcLabs.EasySparkplug.OperationModel.SparkplugException.

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

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.

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows