HistoricalFilter Property

Determines how the subscription handles historical data.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Property HistoricalFilter As BooleanFilter

'Usage
 
Dim instance As SparkplugMetricSubscriptionArguments
Dim value As BooleanFilter
 
instance.HistoricalFilter = value
 
value = instance.HistoricalFilter

public BooleanFilter HistoricalFilter {get; set;}

public:
property BooleanFilter HistoricalFilter {
   BooleanFilter get();
   void set (    BooleanFilter value);
}

Property Value

The default value of this property is Always (BooleanFilter.Always).

Exceptions

Exception	Description
System.ComponentModel.InvalidEnumArgumentException	An invalid enumeration value was used. 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.ComponentModel.InvalidEnumArgumentException

An invalid enumeration value was used.

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

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

SparkplugMetricSubscriptionArguments Class
SparkplugMetricSubscriptionArguments Members
TransientFilter Property
IsHistorical Property

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.