PowerShell functions

Question

What I understood is "Functions in PowerShell scripting are named code block which enables an easy way to organize the script commands."

& Define using:

Function [Scope Type:]<Function name>

For Example:

Function Test
{
    Write-Host "Test method"
} 
Test

Functions with parameters

Example:

Function Test( $msg)
{
    Param ([string] $msg)
    Write-Host "$msg"
} 
Test "Test method"

Output:

Test method

Parameter types:

Named params: Param ([int] $first,[int] $second)
Positional Params: $args[0], $args[1]
Switch params: Param([Switch] $one,[Switch] $two)
Dynamic params: Set-Item -path alias:OpenNotepad -value c:\windows\notepad.exe

How do these "switch parameters" work in PowerShell scripting?

PowerShell Advanced Function Parameter Attributes - Switch Parameters — TessellatingHeckler
– TessellatingHeckler, Commented Sep 21, 2016 at 6:17
I meant both. i.e. providing whatever information I know and asking whatever I do not know — Anitha
– Anitha, Commented Oct 6, 2016 at 10:42

Peter Mortensen · Accepted Answer · 2019-01-05 11:47:44Z

6

It's like a Boolean, but you don't have to (but can) pass $true or $false to it. Example:

function Test-SwitchParam
{
    Param(
        [Switch] $one,
        [Switch] $two
    )

    if ($one)
    {
        Write-Host "Switch one is set"
    }

    if ($two)
    {
        Write-Host "Switch two is set"
    }
}

Now you can call the function like:

Test-SwitchParam -one

The switch $one will be $true, because it is set, and $two will be false.

edited Jan 5, 2019 at 11:47

Peter Mortensen

31.4k22 gold badges110 silver badges134 bronze badges

answered Sep 21, 2016 at 6:26

Martin Brandl

59.4k16 gold badges151 silver badges190 bronze badges

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

Collectives™ on Stack Overflow

PowerShell functions

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related