{"id":17451,"date":"2010-08-12T00:01:00","date_gmt":"2010-08-12T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2010\/08\/12\/pausing-a-windows-powershell-script-to-receive-keyboard-input\/"},"modified":"2010-08-12T00:01:00","modified_gmt":"2010-08-12T00:01:00","slug":"pausing-a-windows-powershell-script-to-receive-keyboard-input","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/pausing-a-windows-powershell-script-to-receive-keyboard-input\/","title":{"rendered":"Pausing a Windows PowerShell Script to Receive Keyboard Input"},"content":{"rendered":"

 \nSummary<\/b>: Pausing execution of a Windows PowerShell script to receive keyboard input can be as simple as using the Read-Host<\/b> cmdlet. But other methods are available.\n \n\"Hey,<\/span><\/span>Hey, Scripting Guy! I would like to pause a Windows PowerShell script and wait for user input. When the user types a particular key on the keyboard, I would like the script to continue. I found an old Hey, Scripting Guy! post called How Can I Pause a Script and Then Resume It When a User Presses a Key on the Keyboard?<\/a> but it is written for VBScript. I do not think I want to attempt using stdin<\/b> from a Windows PowerShell script. I also found an article called Can I Pause and Resume Scripts with Windows PowerShell?<\/a> that was written for the 2009 Summer Scripting Games<\/a>, but that does not work with user input. Is the absence of a solution indicative that I cannot accomplish this using Windows PowerShell?\n— TC\n \n\"Hey,<\/span><\/span>Hello TC,\nMicrosoft Scripting Guy Ed Wilson here. I was up late last night talking to the System Administrators Guild of Australia (SAGE-AU)<\/a> at their conference in Tasmania. It was fun, but I would rather have been there in person. Tasmania is one of the places I have not had the chance to visit. I fell in love with Tasmanian strawberries when I was in Sydney because they are super sweet, but recently they have started growing strawberries that are in the shape of a heart<\/a>. Those would make a wonderful present for my significant other.\nAnyway, TC, sometimes things are so simple that they do not receive much publicity. One such example is pausing a script to wait for user input.<\/p>\n

PauseScriptReadName.ps1<\/strong><\/p>\n

$a<\/span> <\/span>=<\/span> <\/span>read-host<\/span> “what is your name?”
“hello $a”<\/span>\nWhen the PauseScriptReadName.ps1 script runs in the Windows PowerShell ISE, a pop-up window appears, as shown in the following image.\n<\/a>\nThere is, of course, one teeny tiny problem with the script as written. It will pause forever and ever, until the user enters data, or until the computer either restarts or shuts down. This behavior could have adverse consequences to say the least.\nTC, a completely different approach is seen in the pauseTimer.ps1 script shown here: <\/p>\n

pauseTimer.ps1<\/strong><\/p>\n

#<\/span>Requires<\/span> <\/span>-version<\/span> <\/span>2<\/span>.<\/span>0<\/span>
<\/span>Param(<\/span>$timer<\/span> <\/span>=<\/span> <\/span>10<\/span>)<\/span>
<\/span>Function<\/span> <\/span>Test-IsIseHost<\/span>
<\/span>{<\/span>
<\/span><<\/span>#<\/span>
<\/span>.Synopsis<\/span>
<\/span>Determines<\/span> <\/span>if<\/span> <\/span>you<\/span> <\/span>are<\/span> <\/span>running<\/span> <\/span>in<\/span> <\/span>the<\/span> <\/span>Windows<\/span> <\/span>PowerShell<\/span> <\/span>ISE<\/span>
<\/span>.Description<\/span>
<\/span>This<\/span> <\/span>function<\/span> <\/span>determines<\/span> <\/span>if<\/span> <\/span>you<\/span> <\/span>are<\/span> <\/span>running<\/span> <\/span>in<\/span> <\/span>the<\/span> <\/span>Windows<\/span> <\/span>Powershell<\/span>
<\/span>ISE<\/span> <\/span>by<\/span> <\/span>querying<\/span> <\/span>the<\/span> <\/span>$ExecutionContext<\/span> <\/span>automatic<\/span> <\/span>variable.<\/span>
<\/span>.Example<\/span>
<\/span>Test-IsIseHost<\/span>
<\/span>Prints<\/span> <\/span>out<\/span> <\/span>True<\/span> <\/span>if<\/span> <\/span>running<\/span> <\/span>inside<\/span> <\/span>the<\/span> <\/span>ISE,<\/span> <\/span>False<\/span> <\/span>if<\/span> <\/span>run<\/span> <\/span>in<\/span> <\/span>console<\/span>
<\/span>.Example<\/span>
<\/span>if<\/span>(Test-IsIseHost)<\/span> <\/span>{<\/span> “Using the ISE” <\/span>}<\/span>
<\/span>Prints<\/span> <\/span>out<\/span> <\/span>Using<\/span> <\/span>the<\/span> <\/span>ISE<\/span> <\/span>when<\/span> <\/span>run<\/span> <\/span>inside<\/span> <\/span>the<\/span> <\/span>ISE,<\/span> <\/span>otherwise<\/span> <\/span>nothing<\/span>
<\/span>.Inputs<\/span>
<\/span>None<\/span>
<\/span>.Outputs<\/span>
<\/span>[Boolean]<\/span>
<\/span>.Notes<\/span>
<\/span>Name:<\/span> <\/span>Test-IsIseHost<\/span>
<\/span>Book:<\/span> <\/span>Windows<\/span> <\/span>PowerShell<\/span> <\/span>Best<\/span> <\/span>Practices,<\/span> <\/span>Microsoft<\/span> <\/span>Press,<\/span> <\/span>2009<\/span>
<\/span>Author:<\/span> <\/span>Ed<\/span> <\/span>Wilson<\/span>
<\/span>Version:<\/span> <\/span>1<\/span>.<\/span>0<\/span>
<\/span>Date:<\/span> <\/span>4<\/span>\/<\/span>5<\/span>\/<\/span>2009<\/span>
<\/span>.Link<\/span>
<\/span>about_Automatic_variables<\/span>
<\/span>Http:\/\/www.ScriptingGuys.Com<\/span>
<\/span>#<\/span>><\/span>
<\/span>$ExecutionContext<\/span>.Host.name<\/span> <\/span>-match<\/span> “ISE Host$”
<\/span>}<\/span> <\/span>#<\/span>end<\/span> <\/span>Test-IsIseHost<\/span>
<\/span>function<\/span> <\/span>Select-Destination(<\/span>$strIN<\/span>)<\/span>
<\/span>{<\/span> 
<\/span>Clear-Host<\/span>
<\/span>switch(<\/span>$strIN<\/span>.character)<\/span>
<\/span>{<\/span>
“l” <\/span>{<\/span> “$($strIN.Character): local selected” <\/span>;<\/span> <\/span>exit<\/span> <\/span>}<\/span>
“r” <\/span>{<\/span> “$($strIN.Character): Remote selected” <\/span>;<\/span> <\/span>exit<\/span> <\/span>}<\/span>
<\/span>DEFAULT<\/span> <\/span>{<\/span> “$($strIN.Character) is not valid. CountDown Resuming …” <\/span>;<\/span> <\/span>break}<\/span>
<\/span>}<\/span>
<\/span>}<\/span> <\/span>#<\/span>end<\/span> <\/span>function<\/span> <\/span>Select-Destination<\/span>
<\/span>#<\/span> <\/span>***<\/span> <\/span>Entry<\/span> <\/span>point<\/span> <\/span>to<\/span> <\/span>script<\/span> <\/span>***<\/span>
<\/span>If<\/span>(Test-IsIseHost)<\/span> <\/span>{<\/span>“This script does not run in ISE” <\/span>;<\/span> <\/span>exit}<\/span>
“Select machine:”
” l <ocal> r <emote> ”
<\/span>$i<\/span> <\/span>=<\/span> <\/span>1<\/span>
<\/span>Do<\/span>
<\/span>{<\/span>
<\/span>Write-host<\/span> <\/span>-ForeGroundColor<\/span> <\/span>green<\/span> <\/span>-noNewLine<\/span> “Script will time out in $($timer-$i) seconds”
<\/span>$pos<\/span> <\/span>=<\/span> <\/span>$host<\/span>.UI.RawUI.get_cursorPosition()<\/span>
<\/span>#<\/span> <\/span>$pos<\/span>.set_x(<\/span>0<\/span>)<\/span> <\/span>#<\/span> <\/span>This<\/span> <\/span>was<\/span> <\/span>1<\/span>.<\/span>0<\/span> <\/span>syntax<\/span>
<\/span>$pos<\/span>.X<\/span> <\/span>=<\/span> <\/span>0<\/span> <\/span>#<\/span> <\/span>this<\/span> <\/span>is<\/span> <\/span>2<\/span>.<\/span>0<\/span> <\/span>syntax<\/span>
<\/span>$host<\/span>.UI.RawUI.set_cursorPosition(<\/span>$Pos<\/span>)<\/span>
<\/span>if<\/span>(<\/span>$host<\/span>.UI.RawUI.KeyAvailable)<\/span> 
<\/span>{<\/span> 
<\/span>Select-Destination(<\/span>$host<\/span>.ui.rawui.readkey())<\/span> 
<\/span>}<\/span>
<\/span>start-Sleep<\/span> <\/span>-Seconds<\/span> <\/span>1<\/span>
<\/span>if<\/span>(<\/span> <\/span>[math]::log10(<\/span>$timer-$i<\/span>)<\/span> <\/span>-eq<\/span> <\/span>[math]::truncate([math]::log10(<\/span>$timer-$i<\/span>))<\/span> <\/span>)<\/span>
<\/span>{<\/span> <\/span>Clear-Host<\/span> <\/span>}<\/span>
<\/span>$i++<\/span>
<\/span>}While<\/span> <\/span>(<\/span>$i<\/span> <\/span>-le<\/span> <\/span>$timer<\/span>)<\/span> <\/span>;<\/span> <\/span>Clear-Host<\/span> <\/span>;<\/span> “Script timed out after $timer seconds” <\/span>;<\/span> <\/span>exit<\/span>\nKeep in mind that the pauseTimer.ps1 script does not run in the Windows PowerShell ISE. As a result, the Test-IsIseHost<\/b> function is used. If the ISE host is found, the script will exit after displaying a message that the script does not run in the ISE host. The Test-IsIseHost<\/b> function is shown here:<\/p>\n

Function<\/span> <\/span>Test-IsIseHost<\/span>
<\/span>{<\/span>
<\/span><<\/span>#<\/span>
<\/span>.Synopsis<\/span>
<\/span>Determines<\/span> <\/span>if<\/span> <\/span>you<\/span> <\/span>are<\/span> <\/span>running<\/span> <\/span>in<\/span> <\/span>the<\/span> <\/span>Windows<\/span> <\/span>PowerShell<\/span> <\/span>ISE<\/span>
<\/span>.Description<\/span>
<\/span>This<\/span> <\/span>function<\/span> <\/span>determines<\/span> <\/span>if<\/span> <\/span>you<\/span> <\/span>are<\/span> <\/span>running<\/span> <\/span>in<\/span> <\/span>the<\/span> <\/span>Windows<\/span> <\/span>Powershell<\/span>
<\/span>ISE<\/span> <\/span>by<\/span> <\/span>querying<\/span> <\/span>the<\/span> <\/span>$ExecutionContext<\/span> <\/span>automatic<\/span> <\/span>variable.<\/span>
<\/span>.Example<\/span>
<\/span>Test-IsIseHost<\/span>
<\/span>Prints<\/span> <\/span>out<\/span> <\/span>True<\/span> <\/span>if<\/span> <\/span>running<\/span> <\/span>inside<\/span> <\/span>the<\/span> <\/span>ISE,<\/span> <\/span>False<\/span> <\/span>if<\/span> <\/span>run<\/span> <\/span>in<\/span> <\/span>console<\/span>
<\/span>.Example<\/span>
<\/span>if<\/span>(Test-IsIseHost)<\/span> <\/span>{<\/span> “Using the ISE” <\/span>}<\/span>
<\/span>Prints<\/span> <\/span>out<\/span> <\/span>Using<\/span> <\/span>the<\/span> <\/span>ISE<\/span> <\/span>when<\/span> <\/span>run<\/span> <\/span>inside<\/span> <\/span>the<\/span> <\/span>ISE,<\/span> <\/span>otherwise<\/span> <\/span>nothing<\/span>
<\/span>.Inputs<\/span>
<\/span>None<\/span>
<\/span>.Outputs<\/span>
<\/span>[Boolean]<\/span>
<\/span>.Notes<\/span>
<\/span>Name:<\/span> <\/span>Test-IsIseHost<\/span>
<\/span>Book:<\/span> <\/span>Windows<\/span> <\/span>PowerShell<\/span> <\/span>Best<\/span> <\/span>Practices,<\/span> <\/span>Microsoft<\/span> <\/span>Press,<\/span> <\/span>2009<\/span>
<\/span>Author:<\/span> <\/span>Ed<\/span> <\/span>Wilson<\/span>
<\/span>Version:<\/span> <\/span>1<\/span>.<\/span>0<\/span>
<\/span>Date:<\/span> <\/span>4<\/span>\/<\/span>5<\/span>\/<\/span>2009<\/span>
<\/span>.Link<\/span>
<\/span>about_Automatic_variables<\/span>
<\/span>Http:\/\/www.ScriptingGuys.Com<\/span>
<\/span>#<\/span>><\/span>
<\/span>$ExecutionContext<\/span>.Host.name<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

  Summary: Pausing execution of a Windows PowerShell script to receive keyboard input can be as simple as using the Read-Host cmdlet. But other methods are available.   Hey, Scripting Guy! I would like to pause a Windows PowerShell script and wait for user input. When the user types a particular key on the keyboard, […]<\/p>\n","protected":false},"author":595,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[51,22,2,3,4,45],"class_list":["post-17451","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-getting-started","tag-retrieving-input","tag-running","tag-scripting-guy","tag-scripting-techniques","tag-windows-powershell"],"acf":[],"blog_post_summary":"

  Summary: Pausing execution of a Windows PowerShell script to receive keyboard input can be as simple as using the Read-Host cmdlet. But other methods are available.   Hey, Scripting Guy! I would like to pause a Windows PowerShell script and wait for user input. When the user types a particular key on the keyboard, […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/17451","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/users\/595"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=17451"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/17451\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media\/87096"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/media?parent=17451"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=17451"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=17451"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}