powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Wait-Process



NAME
Wait-Process

SYNOPSIS
Waits for the processes to be stopped before accepting more input.

SYNTAX
Wait-Process [-Id] [[-Timeout] ] []

Wait-Process -InputObject [[-Timeout] ] []

Wait-Process [-Name] [[-Timeout] ] []


DESCRIPTION
The Wait-Process cmdlet waits for one or more running processes to be stopped before accepting input. In the Windo
ws 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
Specifies the process IDs of the processes. To specify multiple IDs, use commas to separate the IDs. To find th
e PID of a process, type "get-process". The parameter name ("Id") is optional.

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

-InputObject
Specifies the processes by submitting process objects. Enter a variable that contains the process objects, or t
ype a command or expression that gets the process objects, such as a Get-Process command.

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

-Name
Specifies the process names of the processes. To specify multiple names, use commas to separate the names.

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

-Timeout
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
Accept pipeline input? false
Accept wildcard characters? false


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.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 thi
s 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 variabl
e.

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 paramet
er 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 g
ets 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 th
e 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.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=135277
Get-Process
Start-Process
Stop-Process
Wait-Process
Debug-Process