IAdsNotifications.AddDeviceNotificationExAsync(String, NotificationSettings, Object, Type, Int32[], CancellationToken) Method
Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads.Abstractions (in TwinCAT.Ads.Abstractions.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470
Syntax
C#
Task<ResultHandle> AddDeviceNotificationExAsync(
string symbolPath,
NotificationSettings settings,
Object? userData,
Type type,
int[]? args,
CancellationToken cancel
)Parameters
|
symbolPath String |
The 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') |
|
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
Because notifications allocate TwinCAT system resources, a complementary call to DeleteDeviceNotificationAsync(UInt32, CancellationToken) should always be called when the notification is not used anymore.
See Also
Reference
IAdsNotifications Interface AddDeviceNotificationExAsync Overload TwinCAT.Ads Namespace AdsNotificationEx DeleteDeviceNotificationAsync(UInt32, CancellationToken) {0} Overload {0} Overload {0} Overload
Beckhoff Automation GmbH & Co. KG 2001-2026