IAdsNotificationsAddDeviceNotificationExAsync(UInt32, UInt32, 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(
uint indexGroup,
uint indexOffset,
NotificationSettings settings,
Object? userData,
Type type,
int[]? args,
CancellationToken cancel
)Parameters
|
indexGroup UInt32 |
Contains the index group number of the requested ADS service. |
|
indexOffset UInt32 |
Contains the index offset number of the requested ADS service. |
|
settings NotificationSettings |
The settings. |
|
userData Object |
This object can be used to store user specific data. |
|
type Type |
Type of the object stored in the event argument, only Primitive 'AnyTypes' allowed. |
|
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
If type is a string type, the first element of the parameter args specifies the number of characters of the string. If type is an array type, the number of elements for each dimension has to be specified in the parameter args. Only primitive types (AnyType) are supported by this method. Because notifications allocate TwinCAT system resources, a complementary call to DeleteDeviceNotificationAsync(UInt32, CancellationToken) should always called when the notification is not used anymore.
Reference
IAdsNotifications Interface AddDeviceNotificationExAsync Overload TwinCAT.Ads Namespace DeleteDeviceNotificationAsync(UInt32, CancellationToken) AdsNotificationEx AdsNotificationError {0} Overload {0} Overload {0} Overload
Beckhoff Automation GmbH & Co. KG 2001-2026