{"id":51923,"date":"2009-11-26T00:01:00","date_gmt":"2009-11-26T00:01:00","guid":{"rendered":"https:\/\/blogs.technet.microsoft.com\/heyscriptingguy\/2009\/11\/26\/hey-scripting-guy-how-can-i-add-a-function-to-a-profile-in-windows-powershell\/"},"modified":"2009-11-26T00:01:00","modified_gmt":"2009-11-26T00:01:00","slug":"hey-scripting-guy-how-can-i-add-a-function-to-a-profile-in-windows-powershell","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/scripting\/hey-scripting-guy-how-can-i-add-a-function-to-a-profile-in-windows-powershell\/","title":{"rendered":"Hey, Scripting Guy! How Can I Add a Function to a Profile in Windows PowerShell?"},"content":{"rendered":"

<\/p>\n

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

 <\/p>\n

\"Hey,<\/p>\n

Hey, Scripting Guy! I have been reading your articles about working with Windows PowerShell profiles, and they are pretty cool. However, I have a question. You mentioned on Monday<\/a> that I could add a function to a Windows PowerShell profile. I am not sure how I would do that. Can you add a function to the profile you have been working on all week to give me a better idea?<\/p>\n

— AM<\/p>\n

 <\/p>\n

\"Hey,Hello AM, <\/p>\n

Microsoft Scripting Guy Ed Wilson here. As the hour hand creeps closer to the top of the clock and the evening chill fills the air, my taste in music changes. I am listening to Charlie Daniels on my Zune HD and sipping a cup of Constant Comment tea, and munching on a slice of a Virginia<\/font><\/a> mountain apple that the Scripting Wife picked up on her recent trip to Kentucky<\/font><\/a>. A chunk of artisan cheese<\/font><\/a> rounds out the late-night snack. <\/p>\n

AM, in addition to writing the Hey Scripting Guy! column, one of my favorite things in life is writing Windows PowerShell scripts. I know you asked specifically about adding a function to your profile, and here I am talking about writing Windows PowerShell scripts. This is because a Windows PowerShell profile is basically a script. As I mentioned in Monday’s Hey Scripting Guy! post, it is somewhat akin to the old fashioned AUTOEXEC.BAT file that you may have messed around with 20 years ago. It has a special name, and it is located in a special location. Other than that, it is a plain old everyday Windows PowerShell script. <\/p>\n

A more confusing line in Windows PowerShell 2.0 blurs between functions\/advanced functions and Windows PowerShell scripts. Functions, and in particular advanced functions, have the same elements that a Windows PowerShell script possesses. A function can accept parameters, produce Help, and…but wait, we will be talking about Windows PowerShell functions in a couple weeks (the week of December 21, 2009). We’ll save that discussion for then.<\/p>\n

\"Image<\/p>\n

Note: Portions of today’s Hey Scripting Guy! post are excerpted from the Microsoft Press book, Windows PowerShell 2.0 Best Practices<\/i> by Ed Wilson. The book is available for pre-order<\/a>.<\/p>\n

The easiest way to explain adding a function to the Windows PowerShell profile is to go ahead and add one to it. <\/p>\n

This assumes you have created a Windows PowerShell profile. If you have not, refer back to Monday’s Hey, Scripting Guy! post<\/a>.<\/p>\n

Open your profile in Notepad. You can do this from inside the Windows PowerShell console by typing Notepad<\/span> followed by the $profile<\/span> automatic variable. This is seen here:<\/p>\n

Notepad $profile<\/p>\n

<\/font><\/font><\/span><\/p>\n

The Windows PowerShell profile we have been working on all week is displayed. It is seen in the following image:<\/p>\n

\"Image<\/p>\n


On Monday when we were creating our Windows PowerShell profile, we added comments to create sections of the profile for each of the four things commonly placed in a profile. We now want to add a function, which goes in the (wait for it) function section. One function you will want to add to your Windows PowerShell profile is one that opens your profile in Notepad so that you can edit it. To do this, use the Function<\/b> keyword to tell Windows PowerShell you are creating a function, and then give the function a name. As a best practice when writing Windows PowerShell scripts, you should always use a two-part name that comprises a verb and a noun. For ideas of good verbs to use, you can use the Get-Verb<\/b> function to provide a list of approved verbs:<\/p>\n

\"Image<\/p>\n


Because the Get-Profile<\/b> function will open the profile in Notepad, it “gets” the profile. This is why I named the function Get-Profile<\/b>. The command you wish to execute is placed between the two curly brackets. As a Windows PowerShell best practice, you should add a comment to your closing curly brackets that indicates what the closing bracket is doing. This will greatly facilitate troubleshooting your scripts. <\/p>\n

I learned this best practice when I was taking the ICE train from Regensburg to Hamburg in Germany a few years ago. It is a five-hour trip, and shortly after the train departed the HBF in Regensburg, I introduced an error into the script I was writing. I did not find the error until the train crossed the final bridge before entering the Hamburg HBF. The problem, of course, was a missing curly bracket. As a direct result of that experience, I began adding closing comments to my curly brackets. <\/p>\n

The Get-Profile<\/b> function is seen here:<\/p>\n

Function Get-Profile
{
 <\/span>Notepad $profile
} #end function get-profile<\/p>\n

<\/font><\/span><\/p>\n

The other thing I like to do is to create an alias for a function that I add to my Windows PowerShell profile. The reason I am adding the function to the profile in the first place is because I anticipate I will be using it on a regular basis. If I am going to be using the function on a regular basis, it makes sense to create a alias for it. <\/p>\n

Before creating a new alias, it is a best practice to see if there is a suitable alias already created for the cmdlet in question. By default, Windows PowerShell ships with more than 130 predefined aliases for its 271 cmdlets, and many of them are two-letter aliases. The two-letter aliases are shown here:<\/p>\n

PS C:> Get-Alias ??<\/p>\n

CommandType     <\/span>Name                                                <\/span>Definition
———–     <\/span>—-                                                <\/span>———-
Alias           <\/span>ac             <\/span>                                     <\/span>Add-Content
Alias           <\/span>cd                                                  <\/span>Set-Location
Alias           <\/span>cp                                                  <\/span>Copy-Item
Alias           <\/span>fc                              <\/span>                    <\/span>Format-Custom
Alias           <\/span>fl                                                  <\/span>Format-List
Alias           <\/span>ft                                                  <\/span>Format-Table
Alias           <\/span>fw                                           <\/span>       <\/span>Format-Wide
Alias           <\/span>gc                                                  <\/span>Get-Content
Alias           <\/span>gh                                                  <\/span>Get-Help
Alias           <\/span>gi                                                  <\/span>Get-Item
Alias           <\/span>gl                                                  <\/span>Get-Location
Alias           <\/span>gm                                                  <\/span>Get-Member
Alias           <\/span>gp                                                  <\/span>Get-ItemProperty
Alias         <\/span>  <\/span>gu                                                  <\/span>Get-Unique
Alias           <\/span>gv                                                  <\/span>Get-Variable
Alias           <\/span>ii                                                  <\/span>Invoke-Item
Alias           <\/span>lp            <\/span>                                      <\/span>Out-Printer
Alias           <\/span>ls                                                  <\/span>Get-ChildItem
Alias           <\/span>md                                                  <\/span>mkdir
Alias           <\/span>mi                                <\/span>                  <\/span>Move-Item
Alias           <\/span>mp                                                  <\/span>Move-ItemProperty
Alias           <\/span>mv                                                  <\/span>Move-Item
Alias           <\/span>ni                                              <\/span>    <\/span>New-Item
Alias           <\/span>nv                                                  <\/span>New-Variable
Alias           <\/span>oh                                                  <\/span>Out-Host
Alias           <\/span>ps                                                  <\/span>Get-Process
Alias           <\/span>rd                                                  <\/span>Remove-Item
Alias           <\/span>ri                                                  <\/span>Remove-Item
Alias           <\/span>rm                                                  <\/span>Remove-Item
Alias           <\/span>rp   <\/span>                                               <\/span>Remove-ItemProperty
Alias           <\/span>rv                                                  <\/span>Remove-Variable
Alias           <\/span>sc                                                  <\/span>Set-Content
Alias           <\/span>si       <\/span>                                           <\/span>Set-Item
Alias           <\/span>sl                                                  <\/span>Set-Location
Alias           <\/span>sp                                                  <\/span>Set-ItemProperty
Alias           <\/span>sv                    <\/span>                              <\/span>Set-Variable<\/p>\n

<\/font><\/font><\/span><\/p>\n

You do not want to go to all the trouble of editing your profile, and restarting Windows PowerShell only to find out there is a conflict with your alias choice. My first choice for an alias for the Get-Profile<\/b> function would be gp<\/b>. To see if it is available, use the Get-Alias<\/b> cmdlet as seen here:<\/p>\n

PS C:> Get-Alias gp<\/p>\n

CommandType     <\/span>Name                                                <\/span>Definition
———–     <\/span>—-                                                <\/span>———-
Alias           <\/span>gp                                                  <\/span>Get-ItemProperty<\/p>\n


PS C:><\/p>\n

<\/font><\/font><\/span><\/p>\n

As you can see, the alias gp<\/b> is already taken unfortunately. We have two options, remove the gp<\/b> alias by using the Remove-Item<\/b> cmdlet, or choose something else. To remove the gp<\/b> alias, you will need to use the Force<\/b> parameter. This is because it is a read-only alias. This is seen here: <\/p>\n

PS C:> Remove-Item alias:gp
Remove-Item : Alias was not removed because alias gp is constant or read-only.
At line:1 char:12
+ Remove-Item <<<<  <\/span>alias:gp
    <\/span>+ CategoryInfo          <\/span>: WriteError: (gp:String) [Remove-Item], SessionStateUnauthorizedAccessException
    <\/span>+ FullyQualifiedErrorId : AliasNotRemovable,Microsoft.PowerShell.Commands.RemoveItemCommand<\/p>\n

PS C:> Remove-Item alias:gp -Force
PS C:><\/p>\n

<\/font><\/font><\/span><\/p>\n

In the end, I decided to use p<\/b> as the alias for the <\/b><\/p>\n","protected":false},"excerpt":{"rendered":"

  Hey, Scripting Guy! I have been reading your articles about working with Windows PowerShell profiles, and they are pretty cool. However, I have a question. You mentioned on Monday that I could add a function to a Windows PowerShell profile. I am not sure how I would do that. Can you add a function […]<\/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,144,3,4,45],"class_list":["post-51923","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-scripting","tag-getting-started","tag-profiles","tag-scripting-guy","tag-scripting-techniques","tag-windows-powershell"],"acf":[],"blog_post_summary":"

  Hey, Scripting Guy! I have been reading your articles about working with Windows PowerShell profiles, and they are pretty cool. However, I have a question. You mentioned on Monday that I could add a function to a Windows PowerShell profile. I am not sure how I would do that. Can you add a function […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/51923","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=51923"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/posts\/51923\/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=51923"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/categories?post=51923"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/scripting\/wp-json\/wp\/v2\/tags?post=51923"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}