{"id":15691,"date":"2011-02-05T00:01:00","date_gmt":"2011-02-05T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2011\/02\/05\/use-code-snippets-to-simplify-writing-powershell-scripts\/"},"modified":"2011-02-05T00:01:00","modified_gmt":"2011-02-05T00:01:00","slug":"use-code-snippets-to-simplify-writing-powershell-scripts","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/use-code-snippets-to-simplify-writing-powershell-scripts\/","title":{"rendered":"Use Code Snippets to Simplify Writing PowerShell Scripts"},"content":{"rendered":"

Summary<\/b>: Microsoft Scripting Guy, Ed Wilson, shows how to use code snippets to simplify writing Windows PowerShell scripts.<\/span><\/p>\n

Weekend Scripter: Code snippets <\/span><\/h3>\n

Microsoft Scripting Guy, Ed Wilson, here. I was recently in a meeting in which Jeffrey Snover (the original architect for Windows PowerShell) was also present. I love hearing Jeffrey Snover talk because he is so enthusiastic, and also a genius. Anyway, during the meeting, he mentioned working with snippets, and he said it is a feature that could easily be added to the Windows PowerShell ISE. I quickly jotted the idea down in my meeting notes, and could not wait until I had the opportunity to try it out. <\/span><\/p>\n

I decided to use an instance of the <\/span>System.Windows.Forms.OpenFileDialog<\/a><\/span> class that I had previously used in the <\/span>Hey, Scripting Guy! Can I Open a File Dialog Box with Windows PowerShell?<\/a><\/span> post. While I was at it, I took the opportunity to update the code to <\/span>Windows PowerShell 2.0<\/span><\/a> standards, which includes getting rid of the obsolete LoadWithPartialName<\/b> static method from the <\/span>System.Reflection.Assembly<\/span><\/a> .NET Framework class, as well as using a Try<\/b> \/ Catch<\/b> construction to handle my error handling responsibilities. <\/span><\/p>\n

The complete Get-CodeSnippet<\/b> function is shown here.<\/span><\/p>\n

\n

Get-CodeSnippet.ps1<\/span><\/p>\n

Function Get-CodeSnippet<\/span><\/p>\n

{ <\/span><\/p>\n

<#<\/span><\/p>\n

.Synopsis<\/span><\/p>\n<\/blockquote>\n

\n

Either displays contents of a file in Notepad, or adds the content to<\/span><\/p>\n

current insertion point of script.<\/span><\/p>\n

.Description<\/span><\/p>\n

The Get-CodeSnippet function accepts an input folder of code snippets,<\/span><\/p>\n

and displays a file dialog box that allows you to select a particular<\/span><\/p>\n

file to either view the contents in Notepad, or add the content to <\/span><\/p>\n

your script at the current insertion point.<\/span><\/p>\n

.Example<\/span><\/p>\n

Get-CodeSnippet -InitialDirectory c:\\fso<\/span><\/p>\n

Opens a File Dialog box situated on the c:\\fso directory. Initial view<\/span><\/p>\n

is .ps1 and .psm1 files, but you can choose to view all files. If you<\/span><\/p>\n

select a file, its contents will be displayed in Notepad.<\/span><\/p>\n

.Example<\/span><\/p>\n

Get-CodeSnippet -InitialDirectory c:\\fso -add<\/span><\/p>\n

Opens a File Dialog box situated on the c:\\fso directory. Initial view<\/span><\/p>\n

is .ps1 and .psm1 files, but you can choose to view all files. If you<\/span><\/p>\n

select a file, its contents will automatically be added at the current<\/span><\/p>\n

insertion point of your script.<\/span><\/p>\n

.Parameter InitialDirectory<\/span><\/p>\n

The initial directory to be homed for the Open File Dialog box<\/span><\/p>\n

.Parameter Add<\/span><\/p>\n

A switched parameter that will cause the function to add the content to <\/span><\/p>\n

current script at current insertion point.<\/span><\/p>\n

.Inputs <\/span><\/p>\n

[string]<\/span><\/p>\n

.Outputs <\/span><\/p>\n

[string]<\/span><\/p>\n

.Notes<\/span><\/p>\n

NAME: Get-CodeSnippet<\/span><\/p>\n

AUTHOR: ed wilson, msft<\/span><\/p>\n

LASTEDIT: 01\/26\/2011 13:14:07<\/span><\/p>\n

KEYWORDS: Scripting Techniques, Scripting Templates, Weekend Scripter<\/span><\/p>\n

HSG: WES-2-5-2011<\/span><\/p>\n

.Link<\/span><\/p>\n

Http:\/\/www.ScriptingGuys.com<\/span><\/p>\n

#Requires -Version 2.0<\/span><\/p>\n

#><\/span><\/p>\n

Param(<\/span><\/p>\n

[Parameter(Mandatory=$true)]<\/span><\/p>\n

[string]$InitialDirectory,<\/span><\/p>\n

[switch]$add<\/span><\/p>\n

)<\/span><\/p>\n

If($ExecutionContext.Host.name -notmatch “ISE Host$”)<\/span><\/p>\n

{<\/span><\/p>\n

$response = Read-Host -Prompt “This script must run in Windows PowerShell ISE. <Y> to exit.”<\/span><\/p>\n

if($response -match “y”) { Exit }<\/span><\/p>\n

} #end if<\/span><\/p>\n

Add-Type -AssemblyName “System.windows.forms”<\/span><\/p>\n

$OpenFileDialog = new-object System.Windows.Forms.OpenFileDialog<\/span><\/p>\n

$OpenFileDialog.initialDirectory = $initialDirectory<\/span><\/p>\n

$OpenFileDialog.filter = “PowerShell Scripts (*.ps1;*.psm1)|*.ps1;*.psm1|All files (*.*)| *.*”<\/span><\/p>\n

$OpenFileDialog.ShowDialog() | out-null<\/span><\/p>\n

Try<\/span><\/p>\n

{<\/span><\/p>\n

if(!$add) <\/span><\/p>\n

{ notepad $openfileDialog.filename } <\/span><\/p>\n

if($add)<\/span><\/p>\n

{<\/span><\/p>\n

$content = Get-Content -Path $OpenFileDialog.filename -Encoding ascii -Delimiter `r`n<\/span><\/p>\n

$psise.CurrentFile.Editor.InsertText($content)<\/span><\/p>\n

} #end if $add<\/span><\/p>\n

} #end try<\/span><\/p>\n

Catch [System.Exception]<\/span><\/p>\n

{ “No file was selected.” }<\/span><\/p>\n

} #end function Get-CodeSnippet<\/span><\/p>\n<\/blockquote>\n

The first portion of the Get-CodeSnippet<\/b> function contains the comment-based Help tags. The addition of this Help allows the function to interact with the <\/span>Get-Help cmdlet<\/span><\/a>. For more information about working with comment-based Help, see this Hey, Scripting Guy! post: <\/span>How Do I Add Help Information for Windows PowerShell Parameters?<\/span><\/a><\/p>\n

The Help portion of the function is shown here.<\/span><\/p>\n

\n

<#<\/span><\/p>\n

.Synopsis<\/span><\/p>\n

Either displays contents of a file in Notepad, or adds the content to<\/span><\/p>\n

current insertion point of script.<\/span><\/p>\n

.Description<\/span><\/p>\n

The Get-CodeSnippet function accepts an input folder of code snippets,<\/span><\/p>\n

and displays a file dialog box that allows you to select a particular<\/span><\/p>\n

file to either view the contents in Notepad, or add the content to <\/span><\/p>\n

your script at the current insertion point.<\/span><\/p>\n

.Example<\/span><\/p>\n

Get-CodeSnippet -InitialDirectory c:\\fso<\/span><\/p>\n

Opens a File Dialog box situated on the c:\\fso directory. Initial view<\/span><\/p>\n

is .ps1 and .psm1 files, but you can choose to view all files. If you<\/span><\/p>\n

select a file, its contents will be displayed in Notepad.<\/span><\/p>\n

.Example<\/span><\/p>\n

Get-CodeSnippet -InitialDirectory c:\\fso -add<\/span><\/p>\n

Opens a File Dialog box situated on the c:\\fso directory. Initial view<\/span><\/p>\n

is .ps1 and .psm1 files, but you can choose to view all files. If you<\/span><\/p>\n

select a file, its contents will automatically be added at the current<\/span><\/p>\n

insertion point of your script.<\/span><\/p>\n

.Parameter InitialDirectory<\/span><\/p>\n

The initial directory to be homed for the Open File Dialog box<\/span><\/p>\n

.Parameter Add<\/span><\/p>\n

A switched parameter that will cause the function to add the content to <\/span><\/p>\n

current script at current insertion point.<\/span><\/p>\n

.Inputs <\/span><\/p>\n

[string]<\/span><\/p>\n

.Outputs <\/span><\/p>\n

[string]<\/span><\/p>\n

.Notes<\/span><\/p>\n

NAME: Get-CodeSnippet<\/span><\/p>\n

AUTHOR: ed wilson, msft<\/span><\/p>\n

LASTEDIT: 01\/26\/2011 13:14:07<\/span><\/p>\n

KEYWORDS: Scripting Techniques, Scripting Templates, Weekend Scripter<\/span><\/p>\n

HSG: WES-2-5-2011<\/span><\/p>\n

.Link<\/span><\/p>\n

Http:\/\/www.ScriptingGuys.com<\/span><\/p>\n

#Requires -Version 2.0<\/span><\/p>\n

#><\/span><\/p>\n<\/blockquote>\n

Next, I add two parameters to the function. The first parameter, InitialDirectory, <\/i>is used to specify the directory to search for code snippets, and it is a mandatory parameter. Therefore, it will cause a dialog box to display if it is missing. An example of such a dialog box is shown in the following image.<\/span><\/p>\n

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

The Add<\/i> parameter is a switched parameter; therefore, it only takes effect when it is present. It is used to cause the function to add the selected code snippet to the current insertion point of the script. The parameter section of the script is shown here.<\/span><\/p>\n

\n

Param(<\/span><\/p>\n

[Parameter(Mandatory=$true)]<\/span><\/p>\n

[string]$InitialDirectory,<\/span><\/p>\n

[switch]$add<\/span><\/p>\n

)<\/span><\/p>\n<\/blockquote>\n

The script next makes a check to determine if it is running within the Windows PowerShell ISE. If it is, everything is groovy; but if it is not running inside the Windows PowerShell ISE, a message appears that states the script needs to run in the ISE, and the script prompts to exit the host. This portion of the script is shown here.<\/span><\/p>\n

\n

If($ExecutionContext.Host.name -notmatch “ISE Host$”)<\/span><\/p>\n

{<\/span><\/p>\n

$response = Read-Host -Prompt “This script must run in Windows PowerShell ISE. <Y> to exit.”<\/span><\/p>\n

if($response -match “y”) { Exit }<\/span><\/p>\n

} #end if<\/span><\/p>\n<\/blockquote>\n

Now, I add the System.Windows.Forms<\/b> .NET Framework class to the Windows PowerShell ISE environment by using the Add-Type<\/b> cmdlet. Next, I create an instance of the OpenFileDialog<\/b> class, and I set the initial directory to that obtained via the input parameters. I use a filter that will display only .ps1 and .psm1 files. This portion of the script is shown here.<\/span><\/p>\n

\n

Add-Type -AssemblyName “System.windows.forms”<\/span><\/p>\n

$OpenFileDialog = new-object System.Windows.Forms.OpenFileDialog<\/span><\/p>\n

$OpenFileDialog.initialDirectory = $initialDirectory<\/span><\/p>\n

$OpenFileDialog.filter = “PowerShell Scripts (*.ps1;*.psm1)|*.ps1;*.psm1|All files (*.*)| *.*”<\/span><\/p>\n

$OpenFileDialog.ShowDialog() | out-null<\/span><\/p>\n<\/blockquote>\n

I now use a Try<\/b> \/ Catch<\/b> construction to open the file that is selected in Notepad for viewing. If the Add<\/i> parameter was used when the function was called, the code from the file is added at the current insertion point. This portion of the script is shown here.<\/span><\/p>\n

\n

Try<\/span><\/p>\n

{<\/span><\/p>\n

if(!$add) <\/span><\/p>\n

{ notepad $openfileDialog.filename } <\/span><\/p>\n

if($add)<\/span><\/p>\n

{<\/span><\/p>\n

$content = Get-Content -Path $OpenFileDialog.filename -Encoding ascii -Delimiter `r`n<\/span><\/p>\n

$psise.CurrentFile.Editor.InsertText($content)<\/span><\/p>\n

} #end if $add<\/span><\/p>\n

} #end try<\/span><\/p>\n

Catch [System.Exception]<\/span><\/p>\n

{ “No file was selected.” }<\/span><\/p>\n

} #end function Get-CodeSnippet<\/span><\/p>\n<\/blockquote>\n

To use the Get-CodeSnippet<\/b> function, I can add it to my <\/span>Windows PowerShell ISE Profile<\/span><\/a>, so that it is available, or I can run it once inside the Windows PowerShell ISE. At that point, it is added to the Function: drive<\/b>, and I can call it directly from the immediate window.<\/span><\/p>\n

I now open a new Windows PowerShell ISE sheet, and type the function name in the immediate window, as shown in the following image.<\/span><\/p>\n

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

I then select the code that I want to add to my new script from the Open file<\/b> dialog box that appears, as shown in the following image.<\/span><\/p>\n

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

When I click the Open<\/b> button, the code that is contained inside the file is automatically added to my current script as shown in the following image.<\/span><\/p>\n

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

Of course, this technique is much more powerful than simply adding a single <\/span>WMI<\/span><\/a> command. If the code snippet is designed to be easily incorporated into your current script, it can make things easy. I will expand on this topic tomorrow. <\/span><\/p>\n

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

Ed Wilson, Microsoft Scripting Guy<\/span><\/b><\/p>\n

 <\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

Summary: Microsoft Scripting Guy, Ed Wilson, shows how to use code snippets to simplify writing Windows PowerShell scripts. Weekend Scripter: Code snippets Microsoft Scripting Guy, Ed Wilson, here. I was recently in a meeting in which Jeffrey Snover (the original architect for Windows PowerShell) was also present. I love hearing Jeffrey Snover talk because he […]<\/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":[3,4,220,61,45],"class_list":["post-15691","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-scripting-guy","tag-scripting-techniques","tag-scripting-templates","tag-weekend-scripter","tag-windows-powershell"],"acf":[],"blog_post_summary":"

Summary: Microsoft Scripting Guy, Ed Wilson, shows how to use code snippets to simplify writing Windows PowerShell scripts. Weekend Scripter: Code snippets Microsoft Scripting Guy, Ed Wilson, here. I was recently in a meeting in which Jeffrey Snover (the original architect for Windows PowerShell) was also present. I love hearing Jeffrey Snover talk because he […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/15691","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=15691"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/15691\/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=15691"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=15691"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=15691"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}