TcAdsClient.TryAddDeviceNotificationEx Method

Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.

Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 4.3.0.0

Syntax

C#

public AdsErrorCode TryAddDeviceNotificationEx(
    string variableName,
    NotificationSettings settings,
    Object userData,
    Type type,
    int[] args,
    out uint handle
)

VB

Public Function TryAddDeviceNotificationEx ( 
    variableName As String,
    settings As NotificationSettings,
    userData As Object,
    type As Type,
    args As Integer(),
    <OutAttribute> ByRef handle As UInteger
) As AdsErrorCode

Parameters

variableName	Type: System.String Name of the ADS variable.
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.
args	Type: .System.Int32. Additional arguments.
handle	Type: System.UInt32. The handle.

Return Value

Type: AdsErrorCode
The handle of the notification.

Implements

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

Exceptions

Exception	Condition
ObjectDisposedException

Reference

TcAdsClient Class

TwinCAT.Ads Namespace