SystemServiceExtension.ReadSysServStateAsync Method
Reads the System Service state (AdsSysServState) (asynchronous)
Namespace: TwinCAT.SystemService
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll)
Version: 6.0.328+39e3229
Syntax
C#
public static Task<ResultValue<AdsSysServState>> ReadSysServStateAsync(
this IAdsConnection connection,
CancellationToken cancel
)
Parameters
|
connection |
Type: TwinCAT.Ads.IAdsConnection |
|
cancel |
Type: System.Threading.CancellationToken |
Return Value
Type: Task.ResultValue.AdsSysServState..
A Task<ResultValue`1> representing the asynchronous
operation.
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 |
|---|---|
|
ArgumentOutOfRangeException |
Service only available on AmsPort 10000 (SystemService). Cannot use this function on the specified client! - client |