OPC Studio User's Guide and Reference
NotificationQueueCapacity Property (_NotifyingWidget)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Widgets.ComTypes Namespace > _NotifyingWidget Interface : NotificationQueueCapacity Property
Capacity of the notification queue.
Syntax
'Declaration
 
Property NotificationQueueCapacity As Integer
'Usage
 
Dim instance As _NotifyingWidget
Dim value As Integer
 
instance.NotificationQueueCapacity = value
 
value = instance.NotificationQueueCapacity
int NotificationQueueCapacity {get; set;}
property int NotificationQueueCapacity {
   int get();
   void set (    int value);
}

Property Value

The capacity of the notification queue. Must be a positive integer.

Valid values of this property are in the range from 1 to 2147483647 (Int32.MaxValue).

The default value of this property is 100000.

Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

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

Gets or sets the capacity of the notification queue. This property defines the maximum number of notifications that can be queued for processing at any given time. Exceeding this capacity may result in notifications being dropped or additional actions based on the overflow policy.

An System.ArgumentOutOfRangeException is thrown when setting a value that is less than 1.

This member or type is for use from COM. It is not meant to be used from .NET or Python. Refer to the corresponding .NET member or type instead, if you are developing in .NET or Python.

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