Wait-ScriptSession
Suppresses script execution command prompt until one or all of the script sessions provided are complete.
Syntax
Wait-ScriptSession -Id <String[]> [-Timeout <Int32>] [-Any]
Wait-ScriptSession -Session <ScriptSession[]> [-Timeout <Int32>] [-Any]
Detailed Description
The Wait-ScriptSession cmdlet waits for script session to complete before it displays the command prompt or allows the script to continue. You can wait until any script session is complete, or until all script sessions are complete, and you can set a maximum wait time for the script session. When the commands in the script session are complete, Wait-ScriptSession displays the command prompt and returns a script session object so that you can pipe it to another command. You can use Wait-ScriptSession cmdlet to wait for script sessions, such as those that were started by using the Start-ScriptSession cmdlet.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
Parameters
-Timeout <Int32>
The maximum time to wait for all the other running script sessions to complete.
Aliases
Text
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Any <SwitchParameter>
Returns control to the script or displays the command prompt (and returns the ScriptSession object) when any script session completes. By default, Wait-ScriptSession waits until all of the specified jobs are complete before displaying the prompt.
Aliases
Text
Required?
false
Position?
named
Default Value
​
Accept Pipeline Input?
false
Accept Wildcard Characters?
false
-Id <String[]>
Id(s) of the session to be stopped.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
true (ByValue)
Accept Wildcard Characters?
false
-Session <ScriptSession[]>
Session(s) to be stopped.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
true (ByValue)
Accept Wildcard Characters?
false
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- System.String or Spe.Core.Host.ScriptSession
Outputs
The output type is the type of the objects that the cmdlet emits.
- Spe.Core.Host.ScriptSession
Notes
Help Author: Adam Najmanowicz, Michael West
Examples
EXAMPLE
1
PS master:\> Wait-ScriptSession -Id "My Background Script Session"
Copied!
Related Topics
Last modified 10d ago