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

Question

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?

RobH · Accepted Answer · 2023-07-26 12:46:53Z

32

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

You have a few options:

Use $args (credit to hjpotter92's answer)
Explicitly define your additional parameters, then parse them all in your function to add them to your perl call.

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
 }

edited Jul 26, 2023 at 12:46

RobH

3,6101 gold badge25 silver badges48 bronze badges

answered Nov 13, 2015 at 21:27

briantist

48.3k6 gold badges94 silver badges139 bronze badges

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

3 Comments

Billy ONeal Over a year ago

I don't think your "ValueFromRemainingArguments" link goes to the right place....

briantist Over a year ago

@BillyONeal thank you, updated. It's a long-ish document, so CTRL+F for ValueFromRemainingArguments is recommended.

briantist Over a year ago

@BillyONeal nice, I really should have added an example

tiennen07 · Accepted Answer · 2021-02-04 16:30:35Z

18

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

answered Feb 4, 2021 at 16:30

tiennen07

4264 silver badges6 bronze badges

2 Comments

Alexandre Daubricourt Over a year ago

Huge thanks! It was exactly what I needed. Using $ formats your arguments as a single string. @ is the way to go for a proper pass.

mxt Over a year ago

This is what I was looking for as well. "$args" might work for arguments, but not for parameters. @args seems like the equivalent to bash's "$@"? But since search engines strip special characters, all of this is next to impossible to find.

hjpotter92 · Accepted Answer · 2015-11-13 21:23:16Z

6

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.

answered Nov 13, 2015 at 21:23

hjpotter92

81.1k36 gold badges148 silver badges188 bronze badges

4 Comments

Billy ONeal Over a year ago

But $args would contain '-Suite' and its setting as well. I only want to forward arguments my function is not handling.

hjpotter92 Over a year ago

@BillyONeal You can filter the $args array and remove -Suite parameter.

Billy ONeal Over a year ago

sure, I can think of ways to do it, but if PS already had a formal way to declare this I wanted to use that.

Tom Over a year ago

To pass the received args to another function, one must use @args and not $args

Collectives™ on Stack Overflow

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

3 Answers 3

3 Comments

2 Comments

4 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

2 Comments

4 Comments

Your Answer

Sign up or log in

Post as a guest

Related