AdsClient.DeleteDeviceNotificationAsync Method

Deletes a registered notification asynchronously.

Namespace:  TwinCAT.Ads
Assembly:  TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 6.0.328+39e3229

Syntax

C#

public Task<ResultAds> DeleteDeviceNotificationAsync(
    uint notificationHandle,
    CancellationToken cancel
)

Parameters

notificationHandle

Type: System.UInt32
Notification handle.

cancel

Type: System.Threading.CancellationToken
The cancellation token.

Return Value

Type: Task.ResultAds.
A task that represents the asynchronous 'DeleteDeviceNotification' operation. The ErrorCode property contains the ADS error code after execution.

Implements

IAdsNotifications.DeleteDeviceNotificationAsync(UInt32, CancellationToken)

Exceptions

Exception

Condition

ObjectDisposedException

ClientNotConnectedException

Remarks

This is the complementary method to AddDeviceNotificationAsync Overload overloads and should be called when the notification is not needed anymore the free TwinCAT realtime resources.

Reference

AdsClient Class

TwinCAT.Ads Namespace

AddDeviceNotificationAsync Overload

IAdsNotifications.AdsNotification

TryAddDeviceNotification Overload

AddDeviceNotification Overload