'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Overloads Shared Function ReadWriteValue( _
   ByVal metric As SparkplugMetric, _
   ByVal valueType As Type, _
   ByVal value As Object _
) As SparkplugMetric

'Usage
 
Dim metric As SparkplugMetric
Dim valueType As Type
Dim value As Object
Dim value As SparkplugMetric
 
value = SparkplugMetricExtension.ReadWriteValue(metric, valueType, value)

[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugMetric ReadWriteValue( 
   SparkplugMetric metric,
   Type valueType,
   object value
)

[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugMetric^ ReadWriteValue( 
   SparkplugMetric^ metric,
   Type^ valueType,
   Object^ value
) 

Parameters

metric

The Sparkplug metric that will perform the operation.

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

valueType

The type of the Sparkplug metric, expressed as .NET System.Type.

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

value

The initial value of the Sparkplug metric.

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

Return Value

This method makes the metric both readable and writable. The data written to the metric will become the data subsequently read from the metric.

This method keeps the settings of WritableTimestamp. This means that by default, the timestamp of the metric will not writable. i.e. Sparkplug host applications will not be able to modify it. If you need a different behavior, call the Writable(SparkplugMetric,Boolean) method subsequently, with desired parameter, or modify the WritableTimestamp accordingly (set one or both to true).

In order to make a read-write register of certain type, but without having to specify initial data, consider simply using one of the ValueType(SparkplugMetric,Type) overloads.

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