PerformRead Method

Performs a read operation on the metric.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Sub PerformRead( _
   ByRef data As SparkplugData _
)

'Usage
 
Dim instance As SparkplugMetric
Dim data As SparkplugData
 
instance.PerformRead(data)

public void PerformRead( 
   out SparkplugData data
)

public:
void PerformRead( 
   [Out] SparkplugData^ data
)

Parameters

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

Exceptions

Exception	Description
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.ObjectDisposedException	An operation was performed on a disposed object.

Exception

Description

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.ObjectDisposedException

An operation was performed on a disposed object.

Remarks

If the ReadData change, they are automatically published.

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.