Connectivity Software User's Guide and Reference
ProcessWrite Method (SparkplugMetricExtension)



OpcLabs.EasySparkplug Assembly > OpcLabs.EasySparkplug Namespace > SparkplugMetricExtension Class : ProcessWrite Method
The Sparkplug metric that will perform the operation.

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

The write function, i.e. the function that accepts the Sparkplug data to be written, performs the write operation, and returns a boolean success indication.

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

Specifies that writes of this metric will be processed by the specified write function.
Syntax
'Declaration
 
<ExtensionAttribute()>
<JetBrains.Annotations.NotNullAttribute()>
Public Shared Function ProcessWrite( _
   ByVal metric As SparkplugMetric, _
   ByVal writeFunction As Func(Of SparkplugData,Boolean) _
) As SparkplugMetric
'Usage
 
Dim metric As SparkplugMetric
Dim writeFunction As Func(Of SparkplugData,Boolean)
Dim value As SparkplugMetric
 
value = SparkplugMetricExtension.ProcessWrite(metric, writeFunction)
[Extension()]
[JetBrains.Annotations.NotNull()]
public static SparkplugMetric ProcessWrite( 
   SparkplugMetric metric,
   Func<SparkplugData,bool> writeFunction
)
[Extension()]
[JetBrains.Annotations.NotNull()]
public:
static SparkplugMetric^ ProcessWrite( 
   SparkplugMetric^ metric,
   Func<SparkplugData^,bool>^ writeFunction
) 

Parameters

metric
The Sparkplug metric that will perform the operation.

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

writeFunction
The write function, i.e. the function that accepts the Sparkplug data to be written, performs the write operation, and returns a boolean success indication.

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

Return Value

Returns the metric, internally modified as defined by the method.

This method never returns null (Nothing in Visual Basic).

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This method works by adding an event handler to the Write event of the metric.

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.

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