IAdsNotificationsAddDeviceNotificationAsync(String, Int32, NotificationSettings, Object, CancellationToken) Method
Connects a variable to the ADS client asynchronously. 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#
Task<ResultHandle> AddDeviceNotificationAsync(
string symbolPath,
int dataSize,
NotificationSettings settings,
Object? userData,
CancellationToken cancel
)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 (tag data) |
|
cancel CancellationToken |
The Cancellation token. |
Return Value
Task
ResultHandle
A task that represents the asynchronous
'AddDeviceNotification' operation. The ResultHandle type
parameter contains the created handle (Handle) and the
ErrorCode
after execution.
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
IAdsNotifications Interface AddDeviceNotificationAsync Overload TwinCAT.Ads Namespace AdsNotification DeleteDeviceNotificationAsync(UInt32, CancellationToken) {0} Overload {0} Overload {0} Overload
Beckhoff Automation GmbH & Co. KG 2001-2026