ClockController.Stop Method

Definition

Stops the target Clock.

C#
public void Stop();

Remarks

This method changes the target clock's CurrentState to Stopped.

A Stopped clock can be restarted by using the Begin, Seek, or SeekAlignedToLastTick method.

This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events also will not be raised until then.

Stopping a clock triggers the CurrentGlobalSpeedInvalidated and CurrentStateInvalidated events, but not the Completed event.

Applies to

Product Versions
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10