Size Property (SparkplugMetadata)

An integer representing the size of the metric value.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ValueLimitsAttribute(0, 9223372036854775807)>
Public Property Size As Long

'Usage
 
Dim instance As SparkplugMetadata
Dim value As Long
 
instance.Size = value
 
value = instance.Size

[ValueLimits(0, 9223372036854775807)]
public long Size {get; set;}

[ValueLimits(0, 9223372036854775807)]
public:
property int64 Size {
   int64 get();
   void set (    int64 value);
}

Property Value

The default value of this property is 0.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	The value of an argument is outside the allowable range of values as defined by the invoked method. 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.

Exception

Description

System.ArgumentOutOfRangeException

The value of an argument is outside the allowable range of values as defined by the invoked method.

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 is useful when metric values such as files are sent. This field can be used for the file size.

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

SparkplugMetadata Class
SparkplugMetadata 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.