AdsConnection.TryAddDeviceNotificationEx Method (UInt32, UInt32, NotificationSettings, Object, Type, .Int32., UInt32.)

Connects a variable to the ADS client. 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 AdsErrorCode TryAddDeviceNotificationEx(
    uint indexGroup,
    uint indexOffset,
    NotificationSettings settings,
    Object? userData,
    Type type,
    int[]? args,
    out uint handle
)

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 (tag data)

type

Type: System.Type
Type of the object stored in the event argument ('AnyType')

args

Type: .System.Int32.
The 'AnyType' arguments.

handle

Type: System.UInt32.
The notification handle.

Return Value

Type: AdsErrorCode
The ADS Error code.

Implements

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

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 DeleteDeviceNotification(UInt32) should always called when the notification is not used anymore.

Reference

AdsConnection Class

TryAddDeviceNotificationEx Overload

TwinCAT.Ads Namespace

AdsConnection.DeleteDeviceNotification(UInt32)

AdsConnection.AdsNotificationEx

AdsConnection.AdsNotificationError

AddDeviceNotificationEx Overload

TryAddDeviceNotificationEx Overload

AddDeviceNotificationExAsync Overload