AdsClient.AddDeviceNotificationAsync Method (UInt32, UInt32, Int32, NotificationSettings, Object, CancellationToken)
Adds a device notification as an asynchronous operation.
Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll)
Version: 6.0.328+39e3229
Syntax
C#
public Task<ResultHandle> AddDeviceNotificationAsync(
uint indexGroup,
uint indexOffset,
int dataSize,
NotificationSettings settings,
Object? userData,
CancellationToken cancel
)
Parameters
|
indexGroup |
Type: System.UInt32 |
|
indexOffset |
Type: System.UInt32 |
|
dataSize |
Type: System.Int32 |
|
settings |
Type: TwinCAT.Ads.NotificationSettings |
|
userData |
Type: System.Object |
|
cancel |
Type: System.Threading.CancellationToken |
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
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.