AdsClient.AddDeviceNotificationEx Method (UInt32, UInt32, NotificationSettings, Object, Type, .Int32.)

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. 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 ('AnyType') types are allowed for the parameter type.

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

Syntax

C#

public uint AddDeviceNotificationEx(
    uint indexGroup,
    uint indexOffset,
    NotificationSettings settings,
    Object? userData,
    Type type,
    int[]? args
)

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 Notification 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.

args

Type: .System.Int32.
Additional arguments for 'AnyType' types.

Return Value

Type: UInt32
The notification handle.

Implements

IAdsNotifications.AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, .Int32.)

Remarks

Because notifications allocate TwinCAT system resources, a complementary call to DeleteDeviceNotification(UInt32) should always called when the notification is not used anymore.

Reference

AdsClient Class

AddDeviceNotificationEx Overload

TwinCAT.Ads Namespace

AdsClient.AdsNotificationEx

AddDeviceNotificationEx Overload

AddDeviceNotificationExAsync Overload

TryAddDeviceNotificationEx Overload