Exposing parameters in dependent cmdlets as script parameters

Question

Take for example the optional parameter -Filter on Get-ChildItem.

If one were to incorporate a call to Get-ChildItem in a PowerShell script, how can -Filter be exposed also as an optional parameter on the script such that it will only be passed to the cmdlet if specified?

Mathias R. Jessen · Accepted Answer · 2015-12-16 17:32:08Z

1

You could use the $PSBoundParameters automatic variable to splat the relevant parameters of your script to Get-ChildItem:

[CmdletBinding()]
param(
  [Parameter(Mandatory)]
  [string]$Path,
  [Parameter()]
  [psobject]$NonGetChildItemParam
  [Parameter()]
  [string]$Filter
)

if($PSBoundParameters.ContainsKey("NonGetChildItemParam"))
{
    $PSBoundParameters.Remove("NonGetChildItemParam")
}

Get-ChildItem @PSBoundParameters

answered Dec 16, 2015 at 17:32

Mathias R. Jessen

178k13 gold badges175 silver badges234 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Ansgar Wiechers · Accepted Answer · 2015-12-16 17:10:13Z

0

You need to give the script an optional parameter -Filter and pass its argument through to Get-ChildItem.

Param(
  [Parameter(Mandatory=$true)]
  [string]$Path,
  [Parameter(Mandatory=$false)]
  [scriptblock]$Filter
)

if ($Filter) {
  Get-ChildItem $Path -Filter $Filter
} else {
  Get-ChildItem $Path
}

answered Dec 16, 2015 at 17:10

Ansgar Wiechers

202k27 gold badges286 silver badges363 bronze badges

Collectives™ on Stack Overflow

Exposing parameters in dependent cmdlets as script parameters

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related