| Line | |
|---|
| 1 | '\" |
|---|
| 2 | '\" Copyright (c) 1990 The Regents of the University of California. |
|---|
| 3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
|---|
| 4 | '\" |
|---|
| 5 | '\" See the file "license.terms" for information on usage and redistribution |
|---|
| 6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
|---|
| 7 | '\" |
|---|
| 8 | '\" RCS: @(#) $Id: Sleep.3,v 1.6 2007/12/13 15:22:32 dgp Exp $ |
|---|
| 9 | '\" |
|---|
| 10 | .so man.macros |
|---|
| 11 | .TH Tcl_Sleep 3 7.5 Tcl "Tcl Library Procedures" |
|---|
| 12 | .BS |
|---|
| 13 | .SH NAME |
|---|
| 14 | Tcl_Sleep \- delay execution for a given number of milliseconds |
|---|
| 15 | .SH SYNOPSIS |
|---|
| 16 | .nf |
|---|
| 17 | \fB#include <tcl.h>\fR |
|---|
| 18 | .sp |
|---|
| 19 | \fBTcl_Sleep\fR(\fIms\fR) |
|---|
| 20 | .SH ARGUMENTS |
|---|
| 21 | .AS int ms |
|---|
| 22 | .AP int ms in |
|---|
| 23 | Number of milliseconds to sleep. |
|---|
| 24 | .BE |
|---|
| 25 | .SH DESCRIPTION |
|---|
| 26 | .PP |
|---|
| 27 | This procedure delays the calling process by the number of |
|---|
| 28 | milliseconds given by the \fIms\fR parameter and returns |
|---|
| 29 | after that time has elapsed. It is typically used for things |
|---|
| 30 | like flashing a button, where the delay is short and the |
|---|
| 31 | application need not do anything while it waits. For longer |
|---|
| 32 | delays where the application needs to respond to other events |
|---|
| 33 | during the delay, the procedure \fBTcl_CreateTimerHandler\fR |
|---|
| 34 | should be used instead of \fBTcl_Sleep\fR. |
|---|
| 35 | .SH KEYWORDS |
|---|
| 36 | sleep, time, wait |
|---|
Note: See
TracBrowser
for help on using the repository browser.
