AdsClientAddDeviceNotificationAsync(UInt32, UInt32, Int32, NotificationSettings, Object, CancellationToken) Method
Adds a device notification as an asynchronous operation.
Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll)
Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470
Syntax
C#
public Task<ResultHandle> AddDeviceNotificationAsync(
uint indexGroup,
uint indexOffset,
int dataSize,
NotificationSettings settings,
Object? userData,
CancellationToken cancel
)Parameters
|
indexGroup UInt32 |
The index group number of the requested ADS service. |
|
indexOffset UInt32 |
The index offset number of the requested ADS service. |
|
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.
Implements
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 AdsNotification DeleteDeviceNotificationAsync(UInt32, CancellationToken) {0} Overload {0} Overload {0} Overload
Beckhoff Automation GmbH & Co. KG 2001-2026