PerformWrite Method

Performs a write operation on the metric.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function PerformWrite( _
   ByVal data As SparkplugData _
) As Boolean

'Usage
 
Dim instance As SparkplugMetric
Dim data As SparkplugData
Dim value As Boolean
 
value = instance.PerformWrite(data)

public bool PerformWrite( 
   SparkplugData data
)

public:
bool PerformWrite( 
   SparkplugData^ data
)

Parameters

data: Contains the Sparkplug data that are the input to the Write operation.
The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

Returns true when the write operation has succeeded; returns false otherwise.

Exceptions

Exception Description

Exception	Description
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.InvalidOperationException	A method call was invalid for the object's current state. 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.InvalidOperationException

A method call was invalid for the object's current state.

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 raises the Write event (through the OnWrite method, possibly propagating to the parent edge node or device). If the event is handled and the result is unsuccessful, the method returns false. Otherwise, it updates the WriteData property with the result data. If WritableTimestamp is true and the timestamp is specified, it is used; otherwise, the current UTC time is set. If WriteLoopback is true, the written data is also set as ReadData.

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.