AdsClient.AddDeviceNotificationAsync Method (String, Int32, NotificationSettings, Object, CancellationToken)

Connects a variable to the ADS client asynchronously. 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 Task<ResultHandle> AddDeviceNotificationAsync(
    string symbolPath,
    int dataSize,
    NotificationSettings settings,
    Object? userData,
    CancellationToken cancel
)

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 (tag data)

cancel

Type: System.Threading.CancellationToken
The Cancellation token.

Return Value

Type: Task.ResultHandle.
A task that represents the asynchronous 'AddDeviceNotification' operation. The ResultHandle type parameter contains the created handle (Handle) and the ErrorCode after execution.

Implements

IAdsNotifications.AddDeviceNotificationAsync(String, Int32, NotificationSettings, Object, CancellationToken)

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 DeleteDeviceNotificationAsync(UInt32, CancellationToken) should always be called when the notification is not used anymore.

Reference

AdsClient Class

AddDeviceNotificationAsync Overload

TwinCAT.Ads Namespace

AdsClient.AdsNotification

AdsClient.DeleteDeviceNotificationAsync(UInt32, CancellationToken)

AddDeviceNotification Overload

AddDeviceNotificationAsync Overload

TryAddDeviceNotification Overload