TcAdsClient.AddDeviceNotification Method (String, AdsStream, AdsTransMode, TimeSpan, TimeSpan, Object)

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 int AddDeviceNotification(
    string variableName,
    AdsStream dataStream,
    AdsTransMode transMode,
    TimeSpan cycleTime,
    TimeSpan maxDelay,
    Object userData
)

VB

Public Function AddDeviceNotification ( 
    variableName As String,
    dataStream As AdsStream,
    transMode As AdsTransMode,
    cycleTime As TimeSpan,
    maxDelay As TimeSpan,
    userData As Object
) As Integer

Parameters

variableName	Type: System.String Name of the ADS variable.
dataStream	Type: TwinCAT.Ads.AdsStream The stream that should receive the data.
transMode	Type: TwinCAT.Ads.AdsTransMode Specifies if the event should be fired cyclically or only if the variable has changed.
cycleTime	Type: System.TimeSpan The ADS server checks whether the variable has changed after this time interval. Unit is in ms.
maxDelay	Type: System.TimeSpan The AdsNotification event is fired at the latest when this time has elapsed. The unit is ms.
userData	Type: System.Object This object can be used to store user specific data.

Return Value

Type: Int32
The handle of the notification.

Exceptions

Exception	Condition
AdsErrorException	Thrown when the ADS call fails.

Reference

TcAdsClient Class

AddDeviceNotification Overload

TwinCAT.Ads Namespace

TcAdsClient.DeleteDeviceNotification(Int32)

TcAdsClient.AdsNotification

TcAdsClient.AdsNotificationEx