AdsConnection.AddDeviceNotification Method (String, Int32, NotificationSettings, Object)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.

Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 6.0.328+39e3229

Syntax

C#

public uint AddDeviceNotification(
    string variableName,
    int dataSize,
    NotificationSettings settings,
    Object? userData
)

Parameters

variableName	Type: System.String Name of the variable.
dataSize	Type: System.Int32 Maximum amount of data in bytes to receive with this ADS Notification.
settings	Type: TwinCAT.Ads.NotificationSettings The settings.
userData	Type: System.Object This object can be used to store user specific data (tag data)

Return Value

Type: UInt32
The notification handle.

Implements

IAdsNotifications.AddDeviceNotification(String, Int32, NotificationSettings, Object)

Exceptions

Exception	Condition
ObjectDisposedException
ClientNotConnectedException

Remarks

The

dataSize

Parameter defines the amount of bytes, that will be attached to the AdsNotification as value. Because notifications allocate TwinCAT system resources, a complementary call to DeleteDeviceNotification(UInt32) should always called when the notification is not used anymore.

Reference

AdsConnection Class

AddDeviceNotification Overload

TwinCAT.Ads Namespace

AdsConnection.AdsNotification

AdsConnection.DeleteDeviceNotification(UInt32)

AddDeviceNotification Overload

AddDeviceNotificationAsync Overload

TryAddDeviceNotification Overload