Thread::Sleep Method (Int32)
Updated: August 2009
Suspends the current thread for a specified time.
Assembly: mscorlib (in mscorlib.dll)
Parameters
- millisecondsTimeout
- Type: System::Int32
The number of milliseconds for which the thread is blocked. Specify zero (0) to indicate that this thread should be suspended to allow other waiting threads to execute. Specify Infinite to block the thread indefinitely.
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | The time-out value is negative and is not equal to Infinite. |
The thread will not be scheduled for execution by the operating system for the amount of time specified. This method changes the state of the thread to include WaitSleepJoin.
This method does not perform standard COM and SendMessage pumping.
Note: |
|---|
If you need to sleep on a thread that has STAThreadAttribute, but you want to perform standard COM and SendMessage pumping, consider using one of the overloads of the Join method that specifies a timeout interval. |
The following example uses the Sleep method to block the application's main thread.
using namespace System; using namespace System::Threading; int main() { for (int i = 0; i < 5; i++) { Console::WriteLine("Sleep for 2 seconds."); Thread::Sleep(2000); } Console::WriteLine("Main thread exits."); } /* This example produces the following output: Sleep for 2 seconds. Sleep for 2 seconds. Sleep for 2 seconds. Sleep for 2 seconds. Sleep for 2 seconds. Main thread exits. */
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note: