Wait-Process
Applies To: Windows PowerShell 2.0
Waits for the processes to be stopped before accepting more input.
Syntax
Wait-Process [-Id] <Int32[]> [[-Timeout] <int>] [<CommonParameters>]
Wait-Process -InputObject <Process[]> [[-Timeout] <int>] [<CommonParameters>]
Wait-Process [-Name] <string[]> [[-Timeout] <int>] [<CommonParameters>]
Description
The Wait-Process cmdlet waits for one or more running processes to be stopped before accepting input. In the Windows PowerShell console, this cmdlet suppresses the command prompt until the processes are stopped. You can specify a process by process name or process ID (PID), or pipe a process object to Wait-Process.
Wait-Process works only on processes running on the local computer.
Parameters
-Id <Int32[]>
Specifies the process IDs of the processes. To specify multiple IDs, use commas to separate the IDs. To find the PID of a process, type "Get-Process". The parameter name ("Id") is optional.
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject <Process[]>
Specifies the processes by submitting process objects. Enter a variable that contains the process objects, or type a command or expression that gets the process objects, such as a Get-Process command.
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name <string[]>
Specifies the process names of the processes. To specify multiple names, use commas to separate the names.
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Timeout <int>
Determines the maximum time, in seconds, that Wait-Process waits for the specified processes to stop. When this interval expires, the command displays a non-terminating error that lists the processes that are still running, and ends the wait.
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.
Inputs and Outputs
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.
Inputs |
System.Diagnostics.Process You can pipe a process object to Wait-Process. |
Outputs |
None This cmdlet does not generate any output. |
Notes
This cmdlet uses the WaitForExit method of the System.Diagnostics.Process class. For more information about this method, see the Microsoft .NET Framework SDK.
Example 1
C:\PS>$nid = (get-process notepad).id
C:\PS> stop-process -id $nid
C:\PS> wait-process -id $nid
Description
-----------
These commands stop the Notepad process and then wait for the process to be stopped before proceeding with the next command.
The first command uses the Get-Process cmdlet to get the ID of the Notepad process. It saves it in the $nid variable.
The second command uses the Stop-Process cmdlet to stop the process with the ID saved in $nid.
The third command uses the Wait-Process cmdlet to wait until the Notepad process is stopped. It uses the ID parameter of Wait-Process to identify the process.
Example 2
C:\PS>$p = get-process notepad
C:\PS> wait-process -id $p.id
C:\PS> wait-process -name notepad
C:\PS> wait-process -inputobject $p
Description
-----------
These commands show three different methods of specifying a process to the Wait-Process cmdlet. The first command gets the Notepad process and saves it in the $p variable.
The second command uses the ID parameter, the third command uses the Name parameter, and the fourth command uses the InputObject parameter.
These commands have the same results and can be used interchangeably.
Example 3
C:\PS>wait-process -name outlook, winword -timeout 30
Description
-----------
This command waits 30 seconds for the Outlook and Winword processes to stop. If both processes are not stopped, the cmdlet displays a non-terminating error and the command prompt.
See Also
Concepts
Get-Process
Start-Process
Stop-Process
Wait-Process
Debug-Process