AdsClientTryAddDeviceNotificationEx(String, NotificationSettings, Object, Type, Int32, UInt32) Method

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: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

public AdsErrorCode TryAddDeviceNotificationEx(
    string symbolPath,
    NotificationSettings settings,
    Object? userData,
    Type type,
    int[]? args,
    out uint notificationHandle
)

Parameters

symbolPath  String

Symbol/Instance path of the ADS variable.

settings  NotificationSettings

The Notification settings.

userData  Object

This object can be used to store user specific data (tag data)

type  Type

Type of the object stored in the event argument ('AnyType')

args  Int32

Additional arguments (for 'AnyType')

notificationHandle  UInt32

The notification handle

Return Value

AdsErrorCode
The ADS error code.

Implements

IAdsNotificationsTryAddDeviceNotificationEx(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 AdsNotificationEx DeleteDeviceNotification(UInt32) {0} Overload {0} Overload {0} Overload

Beckhoff Automation GmbH & Co. KG 2001-2026