Search code examples
powershellbindingargumentsparameter-passingpowershell-cmdlet

What is [cmdletbinding()] and how does it work?

According to get-help about_Functions_CmdletBindingAttribute

The CmdletBinding attribute is an attribute of functions that makes them operate like compiled cmdlets

We can use it on the top of our scripts.

What is the function in this case?
An internal implicit "main" function called by the PowerShell engine for all its inputs?

Regarding this syntax:

[CmdletBinding(ConfirmImpact=<String>,
               DefaultParameterSetName=<String>,
               HelpURI=<URI>,
               SupportsPaging=<Boolean>,
               SupportsShouldProcess=<Boolean>,
               PositionalBinding=<Boolean>
               )]

what are we doing?
Instantiating a cmdlbinding object and passing an argument list to its constructor?

This syntax can be found in param() - for example: [Parameter(ValueFromPipeline=$true)].
Does this syntax have a particular name, and can it be found elsewhere?

Lastly, are we able, as simple PowerShellers, to mimic this functionality and modify the behavior of scripts by setting an attribute?

Solution

  • CmdletBinding, Parameter etc. are special attribute classes that scripters can use to define PowerShell's behavior, e.g. make a function an Advanced function with Cmdlet capabilites.

    When you call them via e.g. [CmdletBinding()] you initialize a new instance of the class.

    Read more about the CmdletBindingAttribute class at: MSDN

    Read more about the ParameterAttribute class at: MSDN

    More about Attribute classes here and here