Default parameter values in PowerShell

Introduction

Default parameter values let you set a fallback value for a function's input. This means the function still works even if you don't give it all the information.

When you want a function to work with common settings without needing extra input.

When you want to avoid errors if a user forgets to provide a parameter.

When you want to make your script easier to use by providing sensible defaults.

Syntax

PowerShell

function FunctionName {
  param(
    [type]$ParameterName = DefaultValue
  )
  # Function code here
}

You set the default value by using '=' after the parameter name.

If the caller does not provide a value, the default is used automatically.

Examples

This function says hello. If you don't give a name, it uses "Friend".

PowerShell

function Greet {
  param(
    [string]$Name = "Friend"
  )
  Write-Output "Hello, $Name!"
}

Greet
Greet -Name "Alice"

This function adds two numbers. If you don't give numbers, it adds 5 and 10.

PowerShell

function Add-Numbers {
  param(
    [int]$a = 5,
    [int]$b = 10
  )
  return ($a + $b)
}

Add-Numbers
Add-Numbers -a 3 -b 7

Sample Program

This script defines a function that shows a message. If no message is given, it shows "Hello, World!".

PowerShell

function Show-Message {
  param(
    [string]$Message = "Hello, World!"
  )
  Write-Output $Message
}

Show-Message
Show-Message -Message "PowerShell is fun!"

Important Notes

Default values can be any valid PowerShell expression.

You can mix parameters with and without default values, but parameters with defaults should come last.

Using default values makes your functions more flexible and user-friendly.

Summary

Default parameter values provide fallback inputs for functions.

They help avoid errors when parameters are missing.

They make scripts easier to use by setting common defaults.

Practice

1. What is the main purpose of using default parameter values in a PowerShell function?

easy

A. To make the function run faster

B. To force the user to always provide a value

C. To provide fallback values when no argument is passed

D. To disable the function if parameters are missing

Solution

1. Step 1: Understand default parameter values

   Default parameter values are set to be used when no argument is provided by the user.

2. Step 2: Identify the purpose

   This helps the function run smoothly without errors by using fallback values.

3. Final Answer:

   To provide fallback values when no argument is passed -> Option C

4. Quick Check:

   Default values = fallback values [OK]

Hint: Defaults fill in missing inputs automatically [OK]

Common Mistakes:

• Thinking defaults speed up execution
• Believing defaults force user input
• Assuming defaults disable functions

2. Which of the following is the correct syntax to set a default value of 10 for a parameter named $count in a PowerShell function?

easy

A. param([int]$count <- 10)

B. param([int]$count = 10)

C. param([int]$count : 10)

D. param([int]$count => 10)

Solution

1. Step 1: Recall PowerShell parameter default syntax

   PowerShell uses the equals sign (=) to assign default values in parameters.

2. Step 2: Match syntax to options

   Only param([int]$count = 10) uses = correctly to assign 10 as default.

3. Final Answer:

   param([int]$count = 10) -> Option B

4. Quick Check:

   Default assignment uses = in PowerShell [OK]

Hint: Use = to assign default values in param block [OK]

Common Mistakes:

• Using : or => instead of = for defaults
• Confusing syntax with other languages
• Placing default outside param block

3. What will be the output of this PowerShell function call?

function Greet { param([string]$name = "Guest") "Hello, $name!" }
Greet

medium

A. Hello, Guest!

B. Hello, !

C. Hello, $name!

D. Error: Missing argument

Solution

1. Step 1: Analyze function parameter default

   The parameter $name has a default value "Guest" if no argument is passed.

2. Step 2: Check function call without argument

   Calling Greet without arguments uses the default "Guest".

3. Final Answer:

   Hello, Guest! -> Option A

4. Quick Check:

   Default used when no argument given = Hello, Guest! [OK]

Hint: No argument? Default value is used [OK]

Common Mistakes:

• Expecting empty string output
• Thinking variable name prints literally
• Assuming error on missing argument

4. Identify the error in this PowerShell function definition:

function Show-Info {
 param([string]$info =)
 Write-Output $info
}

medium

A. Missing default value after =

B. Parameter type [string] is invalid

C. Write-Output cannot be used inside functions

D. Function name cannot contain a hyphen

Solution

1. Step 1: Check parameter default syntax

   The parameter $info has an equals sign but no value after it, which is invalid.

2. Step 2: Validate other parts

   Parameter type [string] is valid, Write-Output is allowed, and hyphens are allowed in function names.

3. Final Answer:

   Missing default value after = -> Option A

4. Quick Check:

   Default value must follow = [OK]

Hint: Default values must not be empty after = [OK]

Common Mistakes:

• Leaving = without a value
• Misunderstanding function name rules
• Thinking Write-Output is disallowed

5. You want a PowerShell function Calculate-Sum that adds two numbers, but if the second number is not provided, it should default to the first number. Which parameter default setup achieves this?

hard

A. param([int]$a, [int]$b = 0)

B. param([int]$a = 0, [int]$b = 0)

C. param([int]$a, [int]$b = $null)

D. param([int]$a, [int]$b = $a)

Solution

1. Step 1: Understand PowerShell parameter default evaluation

   PowerShell binds earlier parameters before evaluating defaults for later ones, allowing references to prior parameters.

2. Step 2: Identify the correct setup

   param([int]$a, [int]$b = $a) sets $b to the value of $a when $b is not provided.

3. Final Answer:

   param([int]$a, [int]$b = $a) -> Option D

4. Quick Check:

   Later defaults can reference earlier parameters [OK]

Hint: Later parameters can default using earlier parameter values [OK]

Common Mistakes:

• Using fixed defaults like 0 or $null
• Thinking parameter references are not allowed in defaults
• Assuming defaults must be literal constants