SystemServiceExtensionRestartTwinCATAsync Method
Sends a SystemService Restart to the target system and waits until the system has finished the state changes (SystemService, Port 10000) (asynchronously)
Namespace: TwinCAT.SystemService
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll)
Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470
Syntax
C#
public static Task<ResultWriteControl> RestartTwinCATAsync(
this IAdsConnection connection,
AdsStateCommand request,
TimeSpan pollingRate,
TimeSpan waitTimeout,
bool noReinit,
CancellationToken cancel
)Parameters
|
connection IAdsConnection |
The connection (should be an IAdsConnection on port 10000 in FastWriteThrough mode) |
|
request AdsStateCommand |
The request/command for (Reconfig/Reset) |
|
pollingRate TimeSpan |
The polling rate (should be lower than the connection timeout). |
|
waitTimeout TimeSpan |
The wait timeout. |
|
noReinit Boolean |
if set to true then this method first checks if the system is already in the requested target state. In that case the method can return immediatly. |
|
cancel CancellationToken |
The cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Return Value
Task
ResultWriteControl
A Task<System.Boolean> representing whether the restart is
detected (true), or the timeout occurred (false).
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 |
|---|---|
|
The connection is not conncted to '{AmsPort.SystemService}' - client | |
|
request |
Remarks
Be sure to have the client in FastWriteThrough settings, that the
Reference
SystemServiceExtension Class TwinCAT.SystemService Namespace
Beckhoff Automation GmbH & Co. KG 2001-2026