OnWrite Method (SparkplugMetric)

Raises the Write event, supplying the metric write data.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Protected Overridable Sub OnWrite( _
   ByVal e As SparkplugMetricWriteEventArgs _
)

'Usage
 
Dim instance As SparkplugMetric
Dim e As SparkplugMetricWriteEventArgs
 
instance.OnWrite(e)

protected virtual void OnWrite( 
   SparkplugMetricWriteEventArgs e
)

protected:
virtual void OnWrite( 
   SparkplugMetricWriteEventArgs^ e
)

Parameters

e: The event arguments.
The value of this parameter cannot be null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentException	One of the arguments provided to a method is not valid. 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.
System.ArgumentNullException	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.

System.ArgumentException

One of the arguments provided to a method is not valid.

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.

System.ArgumentNullException

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

The design of this method, including its naming and purpose, is according to Event Design recommendations in "Member design guidelines" by Microsoft.

In the derived classes, you can override this method instead of having to add an event handler for the event.

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

Reference

SparkplugMetric Class
SparkplugMetric Members

Documentation Home, Send Feedback. Resources: Knowledge Base, Product Downloads. Technical support: Online Forums, FAQ.

Missing some example? Ask us for it on our Online Forums! You do not have to own a commercial license in order to use Online Forums, and we reply to every post.