'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Shared Function ConstantValue( _
   ByVal metric As SparkplugMetric, _
   ByVal dataType As SparkplugDataType, _
   ByVal value As Object _
) As SparkplugMetric

'Usage
 
Dim metric As SparkplugMetric
Dim dataType As SparkplugDataType
Dim value As Object
Dim value As SparkplugMetric
 
value = SparkplugMetricExtension.ConstantValue(metric, dataType, value)

[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugMetric ConstantValue( 
   SparkplugMetric metric,
   SparkplugDataType dataType,
   object value
)

[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugMetric^ ConstantValue( 
   SparkplugMetric^ metric,
   SparkplugDataType dataType,
   Object^ value
) 

Parameters

metric

The Sparkplug metric that will perform the operation.

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

dataType

The Sparkplug data type of the metric.

value

The constant value that will be provided by the Sparkplug metric.

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

Return Value

The metric is made read-only, and its minimum sampling interval is set to System.Threading.Timeout.Infinite, effectively disabling the sampling.

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