AdsClient.TryAddDeviceNotificationEx Method (String, NotificationSettings, Object, Type, .Int32., UInt32.)

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

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')
notificationHandle	Type: System.UInt32. The notification handle

Return Value

Type: AdsErrorCode
The ADS error code.

Implements

IAdsNotifications.TryAddDeviceNotificationEx(String, NotificationSettings, Object, Type, .Int32., UInt32.)

Remarks

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

Reference

AdsClient Class

TryAddDeviceNotificationEx Overload

TwinCAT.Ads Namespace

AdsClient.AdsNotificationEx

AdsClient.DeleteDeviceNotification(UInt32)

AddDeviceNotificationEx Overload

AddDeviceNotificationExAsync Overload

TryAddDeviceNotificationEx Overload