AdsClient.AddDeviceNotificationEx Method (String, NotificationSettings, Object, Type, .Int32.)

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(
    string symbolPath,
    NotificationSettings settings,
    Object? userData,
    Type type,
    int[]? args
)

Parameters

symbolPath

Type: System.String
Symbol/Instance path of the ADS variable.

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')

args

Type: .System.Int32.
Additional arguments (for 'AnyType')

Return Value

Type: UInt32
The notification handle.

Implements

IAdsNotifications.AddDeviceNotificationEx(String, NotificationSettings, Object, Type, .Int32.)

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.AdsNotificationEx

AdsClient.DeleteDeviceNotification(UInt32)

AddDeviceNotificationEx Overload

AddDeviceNotificationExAsync Overload

TryAddDeviceNotificationEx Overload