Skip to main content

Powershell Common Parameters - Sometimes they need to go in the bin


This will be a short post. Now and again I find myself needing to know the names of the common parameters that is added to an advanced function. Usually this is because I want to use splatting and want to remove any usage of those built-in parameters. Here is how you can do it.

This time I was working on an advanced function that had a lot of parameters, counting in at 34 to be more precise. There was also a nice mixture of default values and calculated values that required my attention. The function should output those parameters with their values like so:

-Param1 <value>
-Param2 <value>


Now I could use $PSboundparameters, however that would not include the parameters with default values, hence I went the other way and used $MyInvocation.MyCommand.Parameters. This will give me a dictionary list of all the parameters including the common parameters (see help about_commonparameters) and those have to be removed.

A couple of days ago I was browsing around the [System.Management.Automation] and [Microsoft.Powershell] .Net classes looking for something else and I found this cute little static property:
[System.Management.Automation.Cmdlet]::CommonParameters

image

Have been looking for this little bugger for some time now, really nice to find it! Armed with this it is quite easy to remove the CommonParameters from my list of parameters.


image
       
That was nice!

Cheers

Tore

Comments

Popular posts from this blog

Toying with audio in powershell

Controlling mute/unmute and the volume on you computer with powershell.


Add-Type -TypeDefinition @' using System.Runtime.InteropServices; [Guid("5CDF2C82-841E-4546-9722-0CF74078229A"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] interface IAudioEndpointVolume { // f(), g(), ... are unused COM method slots. Define these if you care int f(); int g(); int h(); int i(); int SetMasterVolumeLevelScalar(float fLevel, System.Guid pguidEventContext); int j(); int GetMasterVolumeLevelScalar(out float pfLevel); int k(); int l(); int m(); int n(); int SetMute([MarshalAs(UnmanagedType.Bool)] bool bMute, System.Guid pguidEventContext); int GetMute(out bool pbMute); } [Guid("D666063F-1587-4E43-81F1-B948E807363F"), InterfaceType(ComInterfaceType.InterfaceIsIUnknown)] interface IMMDevice { int Activate(ref System.Guid id, int clsCtx, int activationParams, out IAudioEndpointVolume aev); } [Guid("A95664D2-9614-4F35-A746-DE8DB63617E6"), Interfa…

Serialize data with PowerShell

Currently I am working on a big new module. In this module, I need to persist data to disk and reprocess them at some point even if the module/PowerShell session was closed. I needed to serialize objects and save them to disk. It needed to be very efficient to be able to support a high volume of objects. Hence I decided to turn this serializer into a module called HashData.



Other Serializing methods

In PowerShell we have several possibilities to serialize objects. There are two cmdlets you can use which are built in:
Export-CliXmlConvertTo-JSON
Both are excellent options if you do not care about the size of the file. In my case I needed something lean and mean in terms of the size on disk for the serialized object. Lets do some tests to compare the different types:


(Hashdata.Object.ps1)

You might be curious why I do not use the Export-CliXML cmdlet and just use the [System.Management.Automation.PSSerializer]::Serialize static method. The static method will generate the same xml, however we …

Creating Menus in Powershell

I have created another Powershell module. This time it is about Console Menus you can use to ease the usage for members of your oranization. It is available on GitHub and published to the PowershellGallery. It is called cliMenu.






Puppies
This is a Controller module. It uses Write-Host to create a Menu in the console. Some of you may recall that using Write-Host is bad practice. Controller scripts and modules are the exception to this rule. In addition with WMF5 Write-Host writes to the Information stream in Powershell, so it really does not matter anymore.



Design goal
I have seen to many crappy menus that is a mixture of controller script and business logic. It is in essence a wild west out there, hence my ultimate goal is to create something that makes it as easy as possible to create a menu and change the way it looks.
Make it easy to build Menus and change them Make it as "declarative" as possible
Menus
The module supports multiple Menus, however only one Main-Menu with as man…