{"id":2410,"date":"2013-12-16T00:01:00","date_gmt":"2013-12-16T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2013\/12\/16\/powershell-above-and-beyond-the-minimum-requirements\/"},"modified":"2013-12-16T00:01:00","modified_gmt":"2013-12-16T00:01:00","slug":"powershell-above-and-beyond-the-minimum-requirements","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/powershell-above-and-beyond-the-minimum-requirements\/","title":{"rendered":"PowerShell Above and Beyond the Minimum Requirements"},"content":{"rendered":"

Summary<\/strong>: Two Microsoft Windows PowerShell experts get extreme with the standard Hello World script.<\/p>\n

Microsoft Scripting Guy, Ed Wilson, is here. Last month at the Charlotte PowerShell User Group<\/a> meeting, we played around with some scenarios, and we had each of the attendees work through the tasks to see the various ways they would come up with to solve the scenario. Jason Walker<\/a> and Brian Wilhite<\/a>, both Microsoft PFEs and Windows PowerShell enthusiasts decided that they wanted to go above and beyond the  answer that I provided. Here is Jason to kick off their effort…<\/p>\n

Windows PowerShell doesn’t always have to be about work.  It can be about fun too.  When Ed Wilson started to show off, Brian and I jumped at the opportunity to go above and beyond the Scripting Guy.  Brian reproduced Ed’s effort, and he had the phrase “Hello World!” bouncing around the Windows PowerShell console and changing colors in the process. I thought it would be cool if it could actually say the phrase and change voice each time. I called to action SpVoice Interface (SAPI 5.3)<\/a>.<\/p>\n

There are already scripts floating about on the web that leverage SAPI.SPVoice, but here as another example of how to use it.<\/p>\n

First create the SAPI.SPVOICE COM object:<\/p>\n

$Sapi = New-Object -ComObject sapi.spvoice<\/p>\n

Now get a list of voices by calling the GetVoices<\/strong> method. The following three objects are returned on my computer:<\/p>\n

\"Image<\/a><\/p>\n

If we look by viewing the entire value of the Id<\/strong> property, we see that each voice has a name. The voice names are embedded in the Tokens<\/strong> field. This is shown here:<\/p>\n

\"Image<\/a><\/p>\n

We have voices name David, Hazel, and Zira. Hazel is British, by the way.<\/p>\n

We can set the voice by declaring the Voice<\/strong> property with one of the available voice objects. Here is an example of setting the voice to Hazel:<\/p>\n

\"Image<\/a><\/p>\n

Brian, how about your part?<\/p>\n

Thanks Jason, it was a rather fun night at the Charlotte PowerShell User Group. Because the Scripting Guy was quick to show off his creation, I figured I’d reproduce what he had done by doing the following.<\/p>\n

First, I decided to create a function called “HelloWorld” to capture the existing $Host.UI.RawUI<\/strong> values so that I can set them back when I’m done:<\/p>\n

Function HelloWorld {<\/p>\n

$FGColor = $Host.UI.RawUI.ForegroundColor<\/p>\n

$BGColor = $Host.UI.RawUI.BackgroundColor<\/p>\n

$CurSize = $Host.UI.RawUI.CursorSize<\/p>\n

$WinSize = $Host.UI.RawUI.WindowSize<\/p>\n

Next, I set the CursorSize<\/strong> to a value of 0 so that it’s sort of invisible when my function is executed. I also set the “Hello World!” string to a variable named Hello<\/strong>:<\/p>\n

$Host.UI.RawUI.CursorSize = 0<\/p>\n

$Hello = “Hello World!”<\/p>\n

So next, Jason and I decided to loop through each of the voices that are provided with a default installation of Windows 8.1 to hear them saying “Hello World!” and we bounced the text in different colors across the Windows PowerShell console. This is done with the following script:<\/p>\n

$Sapi = New-Object -ComObject sapi.spvoice<\/p>\n

$Sapi.GetVoices() | ForEach-Object {<\/p>\n

So for each voice, we are grabbing two random numbers, which will represent foreground and background colors:<\/p>\n

$a = Get-Random -Minimum 0 -Maximum 7<\/p>\n

$b = Get-Random -Minimum 8 -Maximum 15<\/p>\n

Here we are setting the foreground and background colors based on the random low and high range variables that we defined:<\/p>\n

$host.UI.RawUI.ForegroundColor = $a<\/p>\n

$host.UI.RawUI.BackgroundColor = $b<\/p>\n

Now we clear the host and set the CursorPosition<\/strong> based on the WindowSize<\/strong> minus the 12 characters in Hello World!<\/strong> and add an extra space, equaling 13:<\/p>\n

Clear-Host<\/p>\n

$Host.UI.RawUI.CursorPosition = @{<\/p>\n

x=(Get-Random -Minimum 0 -Maximum ($WinSize.Width -13))<\/p>\n

y=(Get-Random -Minimum 0 -Maximum $WinSize.Height)<\/p>\n

}<\/p>\n

Here, you’ll see how we output the contents of the Hello<\/strong> variable, then use Jason’s script to “say” the string “Hello World!”, and clear the host:<\/p>\n

$Hello<\/p>\n

$Sapi.Voice = $_<\/p>\n

[void]$Sapi.Speak($Hello)<\/p>\n

Clear-Host<\/p>\n

}## End ForEach-Object<\/p>\n

Next, we set back the foreground and background colors to where they were before we modified their values, then clear the screen:<\/p>\n

$Host.UI.RawUI.ForegroundColor = $FGColor<\/p>\n

$Host.UI.RawUI.BackgroundColor = $BGColor<\/p>\n

$Host.UI.RawUI.CursorSize = $CurSize<\/p>\n

Clear-Host<\/p>\n

}## End Function HelloWorld<\/p>\n

Here are a couple of screenshots of the function in action:<\/p>\n

\"Image<\/a><\/p>\n

\"Image<\/a><\/p>\n

As you can see, Jason and I (in our opinion) went above and beyond what Ed suggested as the most creative way to script the traditional “Hello World!”  The script is available in the Script Center Repository: HelloWorld.ps1<\/a><\/p>\n

~Jason and Brian<\/p>\n

I love it when I introduce an idea and other scripters run with it to see how far they can go. It is a true joy to watch these guys work together and see their ideas. Thank you, Jason and Brian.<\/p>\n

I invite you to follow me on Twitter<\/a> and Facebook<\/a>. If you have any questions, send email to me at scripter@microsoft.com<\/a>, or post your questions on the Official Scripting Guys Forum<\/a>. See you tomorrow. Until then, peace.<\/p>\n

Ed Wilson, Microsoft Scripting Guy<\/strong> <\/p>\n","protected":false},"excerpt":{"rendered":"

Summary: Two Microsoft Windows PowerShell experts get extreme with the standard Hello World script. Microsoft Scripting Guy, Ed Wilson, is here. Last month at the Charlotte PowerShell User Group meeting, we played around with some scenarios, and we had each of the attendees work through the tasks to see the various ways they would come […]<\/p>\n","protected":false},"author":596,"featured_media":87096,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[327,25,56,338,3,4,45],"class_list":["post-2410","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-brian-wilhite","tag-displaying-output","tag-guest-blogger","tag-jason-walker","tag-scripting-guy","tag-scripting-techniques","tag-windows-powershell"],"acf":[],"blog_post_summary":"

Summary: Two Microsoft Windows PowerShell experts get extreme with the standard Hello World script. Microsoft Scripting Guy, Ed Wilson, is here. Last month at the Charlotte PowerShell User Group meeting, we played around with some scenarios, and we had each of the attendees work through the tasks to see the various ways they would come […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/2410","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\/596"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/comments?post=2410"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/2410\/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=2410"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=2410"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=2410"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}