CODEWITHSUNDEEP
functionpowershellfunction-parameter
Billy ONeal
Billy ONeal

Reputation: 106609

How can I pass-through parameters in a powershell function?

I have a function that looks something like this:

function global:Test-Multi {
    Param([string]$Suite)
    & perl -S "$Suite\runall.pl" -procs:$env:NUMBER_OF_PROCESSORS
}

I would like to allow the user to specify more parameters to Test-Multi and pass them directly to the underlying legacy perl script.

Does powershell provide a mechanism to allow additional variadic behavior for this purpose?

Upvotes: 31

Views: 15978

Answers (3)

briantist
briantist

Reputation: 47872

After seeing your comment, option 3 sounds like exactly what you want.

You have a few options:

  1. Use $args (credit to hjpotter92's answer)

  2. Explicitly define your additional parameters, then parse them all in your function to add them to your perl call.

  3. Use a single parameter with the ValueFromRemainingArguments argument, e.g.

     function global:Test-Multi {
     Param(
         [string]$Suite,
         [parameter(ValueFromRemainingArguments = $true)]
         [string[]]$Passthrough
         )
     & perl -S "$Suite\runall.pl" -procs:$env:NUMBER_OF_PROCESSORS @Passthrough
 }

Upvotes: 31

tiennen07
tiennen07

Reputation: 426

$args is not going to pass through arguments correctly. if you want the arguments to remain as separate arguments, you should use @args instead.

Upvotes: 18

hjpotter92
hjpotter92

Reputation: 80653

I'm not sure about what you wish to achieve, but the arguments passed to a function are accessible in the $args variable available inside the function.

Upvotes: 5

Related Questions