Suspends the activity in a script or session for the specified period of time. (Start-Sleep)

   

# NAME
Start-Sleep

# SYNOPSIS
Suspends the activity in a script or session for the specified period of time.

# SYNTAX
Start-Sleep -Milliseconds <int> [<CommonParameters>]

Start-Sleep [-Seconds] <int> [<CommonParameters>]

# DESCRIPTION
The Start-Sleep cmdlet suspends the activity in a script or session for the specified period of time. You can use it for many tasks, such as waiting for an operation to complete or pausing before repeating an operation.

# PARAMETERS
-Milliseconds <int>
Specifies how long the resource sleeps in milliseconds. The parameter can be abbreviated as "-m".

Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Seconds <int>
Specifies how long the resource sleeps in seconds. You can omit the parameter name ("Seconds"), or you can abbreviate it as "-s".

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

# INPUTS
System.Int32
You can pipe the number of seconds to Start-Sleep.

# OUTPUTS
None
This cmdlet does not return any output.

# NOTES

You can also refer to Start-Sleep by its built-in alias, "sleep". For more information, see about_Aliases.

# EXAMPLE 1

C:\PS>Start-Sleep -s 15

# Description
-----------
This command makes all commands in the session sleep for 15 seconds.

# EXAMPLE 2

C:\PS>Start-Sleep -m 500

# Description
-----------
This command makes all the commands in the session sleep for one-half of a second (500 milliseconds).

RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113407

C:\Windows>powershell get-help Tee-Object -full

ColorConsole [Version 1.7.1000] PowerShell 2.0-Export
Microsoft Windows [Version 6.1.7600]
Copyright (c) 2014 Microsoft Corporation.