AdsClient.TryAddDeviceNotification Method (String, Int32, NotificationSettings, Object, UInt32.)

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

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

Syntax

C#

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

Parameters

symbolPath	Type: System.String The symbol/instance path of the ADS variable.
dataSize	Type: System.Int32 Maximum amount of data in bytes to receive with this ADS Notification.
settings	Type: TwinCAT.Ads.NotificationSettings The notification settings.
userData	Type: System.Object This object can be used to store user specific data.
notificationHandle	Type: System.UInt32. The notification handle.

Return Value

Type: AdsErrorCode
The ADS ErrorCode.

Implements

IAdsNotifications.TryAddDeviceNotification(String, Int32, NotificationSettings, Object, UInt32.)

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

AdsClient Class

TryAddDeviceNotification Overload

TwinCAT.Ads Namespace

AdsClient.AdsNotification

AdsClient.TryDeleteDeviceNotification(UInt32)

AddDeviceNotification Overload

AddDeviceNotificationAsync Overload

TryAddDeviceNotification Overload