Powershell: How to pass Boolean Value into Function Parameter?

Question

I've created a function in Powershell and want to pass the Parameter -Foo as a Boolean.

I've simplified my Use-Case for Visualization:

function Get-Foobar {

    [CmdletBinding()]
    param (
        [bool]$Foo
    )

    if ($Foo) {
        Write-Host "Foo!"
    }
    else {
        Write-Host "Bar!"
    }
}

The function works as expected, when I call the function Get-Foobar -Foo $true. But this is not what I want. Just Get-Foobar -Foo should suffice.

Referring to the documentation, specifying the parameter when calling the function should already return a true. But apparently this does not work.

Martin Brandl · Accepted Answer · 2021-07-19 06:18:56Z

7

You are looking for the Switch parameter:

Switch parameters are parameters with no parameter value. Source.

Example:

Param(
    [Parameter(Mandatory=$false)]
    [Switch]
    $Foo
)

answered Jul 19, 2021 at 6:18

Martin Brandl

59.4k16 gold badges151 silver badges190 bronze badges

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

1 Comment

Gill-Bates Over a year ago

Awesome, but weired. I always thought, a Boolean expression behaves like a switch.

Collectives™ on Stack Overflow

Powershell: How to pass Boolean Value into Function Parameter?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related