AdsClient.AddDeviceNotificationExAsync Method (String, NotificationSettings, Object, Type, .Int32., CancellationToken)
Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll)
Version: 6.0.328+39e3229
Syntax
C#
public Task<ResultHandle> AddDeviceNotificationExAsync(
string symbolPath,
NotificationSettings settings,
Object? userData,
Type type,
int[]? args,
CancellationToken cancel
)
Parameters
|
symbolPath |
Type: System.String |
|
settings |
Type: TwinCAT.Ads.NotificationSettings |
|
userData |
Type: System.Object |
|
type |
Type: System.Type |
|
args |
Type: .System.Int32. |
|
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
Because notifications allocate TwinCAT system resources, a complementary call to DeleteDeviceNotificationAsync(UInt32, CancellationToken) should always be called when the notification is not used anymore.