home *** CD-ROM | disk | FTP | other *** search
/ Amiga Developer CD 2.1 / Amiga Developer CD v2.1.iso / CD32 / CD32_Support / examples / SA_Examples / lowlevel / TimerInt / TimerInt.doc < prev    next >
Encoding:
Text File  |  1993-08-31  |  1.8 KB  |  62 lines
  1. TimerInt
  2.  
  3. NAME
  4.     TimerInt -- lowlevel.library/AddTimerInt(), RemTimerInt(),
  5.         StartTimerInt(), StopTimerInt() Test Program
  6.  
  7. SYNOPSIS
  8.     CLI:
  9.         TimerInt
  10.  
  11.     Workbench:
  12.         TimerInt
  13.  
  14. FUNCTION
  15.     TimerInt is a part of a series of test programs for lowlevel.library.
  16.     The purpose of TimerInt is to test the lowlevel.library/AddTimerInt(),
  17.     RemTimerInt(), StartTimerInt(), and StopTimerInt() functions by
  18.     installing a timer interrupt handler and starting and stopping
  19.     one-shot and continuous timers.
  20.  
  21.     To set the timer interval, use the Interval integer gadget.
  22.  
  23.     To select the timer mode (one-shot or continuous), use the Mode
  24.     cycle gadget.
  25.  
  26.     To start the timer interrupt, select the Start button gadget.
  27.     Note that to run a one-shot timer multiple times, the Start button
  28.     gadget must be selected for each run.
  29.  
  30.     To stop the timer interrupt, select the Stop button gadget.
  31.  
  32.     The Deviation number gadget displays the maximum deviation (in
  33.     microseconds) between the timer interrupt and independent timings
  34.     performed using the system clock.
  35.  
  36.     To terminate TimerInt, select the close gadget of the window.
  37.  
  38. INPUTS
  39.     None
  40.  
  41. RESULT
  42.     RETURN_OK (0)       -   Success
  43.     RETURN_WARN (5)     -   Warning
  44.     RETURN_FAIL (20)    -   Failure
  45.  
  46. EXAMPLE
  47.  
  48. NOTES
  49.     To ensure that the specified user data for the keyboard interrupt
  50.     handler is correctly received, the keyboard interrupt handler
  51.     compares the interrupt data against a magic cookie. If any calls
  52.     to interrupt routine had incorrect interrupt data, the user is
  53.     notified when the program exits and a warning (RETURN_WARN (5))
  54.     is returned by KBInt.
  55.  
  56. BUGS
  57.     If timer interrupt deviates from timing with timer.device by one second
  58.     or more, an incorrect deviation will be reported because the deviation
  59.     is measured in microseconds only.
  60.  
  61. SEE ALSO
  62.