AdsClientExtensions.WhenNotification Method (IAdsConnection, ISymbol, NotificationSettings)

Gets an observable sequence of SymbolValueNotifications.

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

Syntax

C#

public static IObservable<SymbolValueNotification> WhenNotification(
    this IAdsConnection client,
    ISymbol symbol,
    NotificationSettings settings
)

Parameters

client	Type: TwinCAT.Ads.IAdsConnection The client.
symbol	Type: TwinCAT.TypeSystem.ISymbol The symbol to observe.
settings	Type: TwinCAT.Ads.NotificationSettings Notification settings.

Return Value

Type: IObservable.SymbolValueNotification.
IObservable<NotificationValue>.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAdsConnection. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	symbol
ArgumentOutOfRangeException	Symbol is not an IValueSymbol - symbol

Reference

AdsClientExtensions Class

WhenNotification Overload

TwinCAT.Ads.Reactive Namespace

AdsClientExtensions.WhenNotification(IAdsConnection, IList.ISymbol., NotificationSettings)