IAdsNotificationsTryAddDeviceNotification(String, Int32, NotificationSettings, Object, UInt32) Method

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

Syntax

C#

AdsErrorCode TryAddDeviceNotification(
    string symbolPath,
    int dataSize,
    NotificationSettings settings,
    Object? userData,
    out uint handle
)

Parameters

symbolPath  String

The symbol/instance path of the ADS variable.

dataSize  Int32

Maximum amount of data in bytes to receive with this ADS Notification

settings  NotificationSettings

The notification settings.

userData  Object

This object can be used to store user specific data.

handle  UInt32

The notification handle.

Return Value

AdsErrorCode
The ADS ErrorCode.

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 be called when the notification is not used anymore.

Reference

IAdsNotifications Interface TryAddDeviceNotification Overload TwinCAT.Ads Namespace AdsNotification TryDeleteDeviceNotification(UInt32) {0} Overload {0} Overload {0} Overload

Beckhoff Automation GmbH & Co. KG 2001-2026