AdsClient.AddDeviceNotificationEx Method (UInt32, UInt32, NotificationSettings, Object, Type)

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

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

Syntax

C#

public uint AddDeviceNotificationEx(
    uint indexGroup,
    uint indexOffset,
    NotificationSettings settings,
    Object? userData,
    Type type
)

Parameters

indexGroup	Type: System.UInt32 Contains the index group number of the requested ADS service.
indexOffset	Type: System.UInt32 Contains the index offset number of the requested ADS service.
settings	Type: TwinCAT.Ads.NotificationSettings The Notification settings.
userData	Type: System.Object This object can be used to store user specific data (tag data)
type	Type: System.Type Type of the object stored in the event argument ('AnyType')

Return Value

Type: UInt32
The notification handle.

Implements

IAdsNotifications.AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type)

Remarks

Because notifications allocate TwinCAT system resources, a complementary call to DeleteDeviceNotification(UInt32) should always called when the notification is not used anymore.

Reference

AdsClient Class

AddDeviceNotificationEx Overload

TwinCAT.Ads Namespace

AdsClient.DeleteDeviceNotification(UInt32)

AdsClient.AdsNotificationEx

AdsClient.AdsNotificationError

AddDeviceNotificationEx Overload

TryAddDeviceNotificationEx Overload

AddDeviceNotificationExAsync Overload