AdsConnection.AddDeviceNotificationExAsync Method (UInt32, UInt32, 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(
    uint indexGroup,
    uint indexOffset,
    NotificationSettings settings,
    Object? userData,
    Type type,
    int[]? args,
    CancellationToken cancel
)

Parameters

indexGroup

Type: System.UInt32
Contains the index group number of the requested ADS service.

indexOffset

Type: System.UInt32
Contains the index offset number of the requested ADS service.

settings

Type: TwinCAT.Ads.NotificationSettings
The settings.

userData

Type: System.Object
This object can be used to store user specific data.

type

Type: System.Type
Type of the object stored in the event argument, only Primitive 'AnyTypes' allowed.

args

Type: .System.Int32.
Additional arguments (for 'AnyType')

cancel

Type: System.Threading.CancellationToken
The Cancellation token.

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

IAdsNotifications.AddDeviceNotificationExAsync(UInt32, UInt32, NotificationSettings, Object, Type, .Int32., CancellationToken)

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

AdsConnection Class

AddDeviceNotificationExAsync Overload

TwinCAT.Ads Namespace

AdsConnection.DeleteDeviceNotificationAsync(UInt32, CancellationToken)

AdsConnection.AdsNotificationEx

AdsConnection.AdsNotificationError

AddDeviceNotificationEx Overload

TryAddDeviceNotificationEx Overload

AddDeviceNotificationExAsync Overload