home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / Sleep.3 < prev    next >
Encoding:
Text File  |  1993-04-01  |  1.9 KB  |  51 lines
  1. '\"
  2. '\" Copyright (c) 1990 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/Sleep.3,v 1.4 93/04/01 09:41:59 ouster Exp $ SPRITE (Berkeley)
  22. '\" 
  23. .so man.macros
  24. .HS Tk_Sleep tkc
  25. .BS
  26. .SH NAME
  27. Tk_Sleep \- delay execution for a given number of milliseconds
  28. .SH SYNOPSIS
  29. .nf
  30. \fB#include <tk.h>\fR
  31. .sp
  32. \fBTk_Sleep\fR(\fIms\fR)
  33. .SH ARGUMENTS
  34. .AP int ms in
  35. Number of milliseconds to sleep.
  36. .BE
  37.  
  38. .SH DESCRIPTION
  39. .PP
  40. This procedure delays the calling process by the number of
  41. milliseconds given by the \fIms\fR parameter, and returns
  42. after that time has elapsed.  It is typically used for things
  43. like flashing a button, where the delay is short and the
  44. application needn't do anything while it waits.  For longer
  45. delays where the application needs to respond to other events
  46. during the delay, the procedure \fBTk_CreateTimerHandler\fR
  47. should be used instead of \fBTk_Sleep\fR.
  48.  
  49. .SH KEYWORDS
  50. sleep, time, wait
  51.