IAdsNotifications.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.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 6.0.328+39e3229

Syntax

C#

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

Parameters

symbolPath

Type: System.String
Symbol / Instance path of the ADS 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.

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

IAdsNotifications Interface

AddDeviceNotification Overload

TwinCAT.Ads Namespace

IAdsNotifications.AdsNotification

IAdsNotifications.DeleteDeviceNotification(UInt32)

AddDeviceNotification Overload

AddDeviceNotificationAsync Overload

TryAddDeviceNotification Overload