AdsClientTryAddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, Int32, UInt32) Method

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: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

Syntax

C#

public AdsErrorCode TryAddDeviceNotificationEx(
    uint indexGroup,
    uint indexOffset,
    NotificationSettings settings,
    Object? userData,
    Type anyType,
    int[]? args,
    out uint handle
)

Parameters

indexGroup  UInt32

Contains the index group number of the requested ADS service.

indexOffset  UInt32

Contains the index offset number of the requested ADS service.

settings  NotificationSettings

The Notification settings.

userData  Object

This object can be used to store user specific data (tag data)

anyType  Type

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

args  Int32

The 'AnyType' arguments.

handle  UInt32

The notification handle.

Return Value

AdsErrorCode
The ADS Error code.

Implements

IAdsNotificationsTryAddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, Int32, UInt32)

Exceptions

Exception

Condition

ObjectDisposedException

ClientNotConnectedException

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

AdsClient Class TryAddDeviceNotificationEx Overload TwinCAT.Ads Namespace DeleteDeviceNotification(UInt32) AdsNotificationEx AdsNotificationError {0} Overload {0} Overload {0} Overload

Beckhoff Automation GmbH & Co. KG 2001-2026