stop-timer

Arguments: timer

Stops timer, which must be an instance of the timer class, from running (if it is running). That is, it makes its active property nil.

If a timer is intended to fire only once after it is started, then stop-timer can be called in the timer's on-timer function to prevent further firings until the timer is restarted. Otherwise stop-timer may be called at any arbitrary time when no further firings are desired.

See cg-timers.htm for more information on timers.

Copyright (c) 1998-2016, Franz Inc. Oakland, CA., USA. All rights reserved.
This page was not revised from the 8.1 page.
Created 2010.1.21.