Using CmdletBinding without formal parameters

Question

Following a comment to another question, I tried adding CmdletBinding to a function. Here is a toy example

function example {
  [CmdletBinding()]Param()
  $args
}

But trying to use it I get:

> example foo
example : A positional parameter cannot be found that accepts argument 'foo'.
At line:1 char:1
+ example foo
+ ~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [example], ParameterBindingException
    + FullyQualifiedErrorId : PositionalParameterNotFound,example

What should I fix so that the function will work with any argument(s) passed to it?

Vesper · Accepted Answer · 2015-07-20 12:20:19Z

3

You need to declare a parameter to accept that "foo" within the Param() block. Here's the manual on advanced parameters. In your case, you want the parameter to accept any value that's not matched to any other parameters (none), so you declare it using ValueFromRemainingArguments argument set to true.

function example {
    [CmdletBinding()]
    Param(
        [parameter(ValueFromRemainingArguments=$true)][String[]] $args
    )
    $args
}

An example on how to use:

PS K:\> example foo bar hum
foo
bar
hum

answered Jul 20, 2015 at 12:20

Vesper

18.8k6 gold badges41 silver badges63 bronze badges

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

3 Comments

IttayD Over a year ago

This doesn't work with example -v or example -args -v

Vesper Over a year ago

-v is verbose flag, it is matched by [cmdletbinding()] and sets local $verbosepreference variable to true, or if written -v:$false, to false. You can make it display by quoting, example "-v".

Vesper Over a year ago

Just tried example -vvv and got the -vvv in result. Anyway, what do you actually want?

Collectives™ on Stack Overflow

Using CmdletBinding without formal parameters

1 Answer 1

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related