IAdsNotifications.TryAddDeviceNotification Method (UInt32, UInt32, Int32, NotificationSettings, Object, UInt32.)

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#

AdsErrorCode TryAddDeviceNotification(
    uint indexGroup,
    uint indexOffset,
    int dataSize,
    NotificationSettings settings,
    Object? userData,
    out uint handle
)

Parameters

indexGroup	Type: System.UInt32 The index group number of the requested ADS service.
indexOffset	Type: System.UInt32 The index offset number of the requested ADS service.
dataSize	Type: System.Int32 Maximum amount of data in bytes to receive with this ADS Notification.
settings	Type: TwinCAT.Ads.NotificationSettings The Notification settings.
userData	Type: System.Object This object can be used to store user specific data (tag data)
handle	Type: System.UInt32. The notification handle.

Return Value

Type: AdsErrorCode
The ADS error code.

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 TryDeleteDeviceNotification(UInt32) should always called when the notification is not used anymore.

Reference

IAdsNotifications Interface

TryAddDeviceNotification Overload

TwinCAT.Ads Namespace

IAdsNotifications.TryDeleteDeviceNotification(UInt32)

IAdsNotifications.AdsNotification

IAdsNotifications.AdsNotificationError

AddDeviceNotification Overload

TryAddDeviceNotification Overload

AddDeviceNotificationAsync Overload