Active Property (AESubscriptionParameters)

Denotes active or inactive subscription.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<DataMemberAttribute()>
<DefaultValueAttribute(True)>
Public Property Active As Boolean

'Usage
 
Dim instance As AESubscriptionParameters
Dim value As Boolean
 
instance.Active = value
 
value = instance.Active

[DataMember()]
[DefaultValue(true)]
public bool Active {get; set;}

[DataMember()]
[DefaultValue(true)]
public:
property bool Active {
   bool get();
   void set (    bool value);
}

Remarks

If the client deactivates the subscription, then the server will no longer send event notifications to the client based on that subscription, and has no responsibility to buffer or maintain the event notifications. Thus event notifications may be lost.

Even if the subscription is inactive, the Refresh method will still function. In effect, this allows a client to obtain current condition states from time to time (by invoking Refresh) without the need to process event notifications in "real time".

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2012, Windows Server 2016; .NET Core, .NET 5, .NET 6: Linux, macOS, Microsoft Windows

Reference

AESubscriptionParameters Class
AESubscriptionParameters Members