SystemServiceExtensionReadSysServStateAsync Method
Reads the System Service state (AdsSysServState) (asynchronous)
Namespace: TwinCAT.SystemService
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll)
Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470
Syntax
C#
public static Task<ResultValue<AdsSysServState>> ReadSysServStateAsync(
this IAdsConnection connection,
CancellationToken cancel
)Parameters
|
connection IAdsConnection |
The client. |
|
cancel CancellationToken |
The cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Return Value
Task
ResultValueAdsSysServState
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 |
|---|---|
|
Service only available on AmsPort 10000 (SystemService). Cannot use this function on the specified client! - client |
Reference
SystemServiceExtension Class TwinCAT.SystemService Namespace
Beckhoff Automation GmbH & Co. KG 2001-2026