OPC Studio User's Guide and Reference
Active Property (AESubscriptionParameters)



OpcLabs.EasyOpcClassicCore Assembly > OpcLabs.EasyOpc.AlarmsAndEvents Namespace > AESubscriptionParameters Class : Active Property
Denotes active or inactive subscription.
Syntax
'Declaration
 
<DataMemberAttribute()>
Public Property Active As Boolean
'Usage
 
Dim instance As AESubscriptionParameters
Dim value As Boolean
 
instance.Active = value
 
value = instance.Active
[DataMember()]
public bool Active {get; set;}
[DataMember()]
public:
property bool Active {
   bool get();
   void set (    bool value);
}

Property Value

The default value of this property is True.

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

This method or property does not throw any exceptions, aside from execution exceptions such as System.Threading.ThreadAbortException or System.OutOfMemoryException.

Requirements

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

See Also