Custom error messages in PowerShell - Mini Project: Build & Apply

Custom error messages

📖 Scenario: You are writing a PowerShell script to check if a file exists before processing it. If the file does not exist, you want to show a clear, custom error message to help users understand what went wrong.

🎯 Goal: Build a PowerShell script that checks for a file's existence and shows a custom error message if the file is missing.

📋 What You'll Learn

Create a variable holding the file path

Create a variable holding a custom error message

Use an if statement to check if the file exists

Show the custom error message if the file does not exist

Print a success message if the file exists

💡 Why This Matters

🌍 Real World

Scripts often need to check if files or resources exist before working with them. Clear error messages help users fix problems quickly.

💼 Career

Knowing how to handle errors and show helpful messages is important for system administrators and automation engineers to create reliable scripts.

1

Set the file path variable

Create a variable called $filePath and set it to the string "C:\temp\data.txt".

PowerShell

# Create the file path variable
# Your code here

Hint

Use = to assign the string to the variable $filePath.

2

Create the custom error message variable

Create a variable called $errorMessage and set it to the string "Error: The file does not exist at the specified path.".

PowerShell

$filePath = "C:\temp\data.txt"
# Create the custom error message variable
# Your code here

Hint

Assign the error message string to $errorMessage using =.

3

Check if the file exists

Write an if statement that uses Test-Path with $filePath to check if the file exists. Inside the if, write a Write-Host command to print "File found.". In the else block, write a Write-Host command to print the $errorMessage variable.

PowerShell

$filePath = "C:\temp\data.txt"
$errorMessage = "Error: The file does not exist at the specified path."

# Write an if statement to check if the file exists
# Use Write-Host to print messages
# Your code here

Hint

Use Test-Path $filePath inside the if condition. Use Write-Host to print messages.

4

Display the result

Run the script to display either File found. if the file exists or the custom error message if it does not.

PowerShell

$filePath = "C:\temp\data.txt"
$errorMessage = "Error: The file does not exist at the specified path."

if (Test-Path $filePath) {
    Write-Host "File found."
} else {
    Write-Host $errorMessage
}

# Run the script to see the output
# Your code here

Hint

Run the script in PowerShell. It will print one of the two messages depending on the file's existence.

Practice

1. What is the main purpose of using custom error messages in PowerShell scripts?

easy

A. To hide all errors from the user

B. To make the script run faster

C. To make error messages clearer and easier to understand for users

D. To automatically fix errors without user input

Solution

1. Step 1: Understand the role of error messages

   Error messages help users know what went wrong in a script.

2. Step 2: Identify the benefit of custom messages

   Custom messages explain errors in simple words, making them easier to fix.

3. Final Answer:

   To make error messages clearer and easier to understand for users -> Option C

4. Quick Check:

   Custom error messages improve clarity = A [OK]

Hint: Custom messages explain errors simply for users [OK]

Common Mistakes:

• Thinking custom messages speed up scripts
• Believing errors should be hidden completely
• Assuming errors fix themselves automatically

2. Which of the following is the correct syntax to catch an error and display a custom message in PowerShell?

easy

A. try { command } finally { Write-Host 'Error occurred' }

B. catch { command } try { Write-Host 'Error occurred' }

C. try command catch Write-Host 'Error occurred'

D. try { command } catch { Write-Host 'Error occurred' }

Solution

1. Step 1: Recall try-catch syntax

   PowerShell uses try { } catch { } blocks to handle errors.

2. Step 2: Identify correct placement of Write-Host

   The custom message should be inside the catch block to show on error.

3. Final Answer:

   try { command } catch { Write-Host 'Error occurred' } -> Option D

4. Quick Check:

   try-catch with message in catch = A [OK]

Hint: Put custom message inside catch block [OK]

Common Mistakes:

• Swapping try and catch blocks
• Using finally instead of catch for errors
• Missing curly braces around blocks

3. What will be the output of this script?

try {
  Get-Item 'C:\nonexistentfile.txt'
} catch {
  Write-Host 'File not found, please check the path.'
}

medium

A. Get-Item : Cannot find path 'C:\nonexistentfile.txt' because it does not exist.

B. File not found, please check the path.

C. No output, script runs silently

D. Syntax error in script

Solution

1. Step 1: Understand Get-Item behavior

   Get-Item throws an error if the file does not exist.

2. Step 2: Check catch block output

   The catch block catches the error and prints the custom message.

3. Final Answer:

   File not found, please check the path. -> Option B

4. Quick Check:

   Error caught and custom message shown = C [OK]

Hint: Catch block shows custom message on error [OK]

Common Mistakes:

• Expecting default error instead of custom message
• Thinking script runs silently without output
• Confusing syntax error with runtime error

4. Identify the error in this script that tries to show a custom error message:

try {
  Get-Content 'missingfile.txt'
} catch {
  Write-Host Error: File missing
}

medium

A. Missing quotes around the error message string

B. Incorrect use of Get-Content command

C. No catch block present

D. Try block syntax is wrong

Solution

1. Step 1: Check catch block syntax

   Write-Host requires the message to be a string inside quotes.

2. Step 2: Identify missing quotes

   Error: File missing is not quoted, causing a syntax error.

3. Final Answer:

   Missing quotes around the error message string -> Option A

4. Quick Check:

   Strings need quotes in Write-Host = D [OK]

Hint: Always quote strings in Write-Host [OK]

Common Mistakes:

• Forgetting quotes around text
• Assuming Get-Content is wrong here
• Thinking catch block is missing

5. You want to create a script that reads a file and shows a custom error message only if the file is missing, but lets other errors pass through. Which approach is best?

hard

A. Use try-catch and check if the error is 'ItemNotFoundException' before showing custom message

B. Use try-catch and always show the same custom message for any error

C. Use only try block without catch to let errors show normally

D. Use catch block to ignore all errors silently

Solution

1. Step 1: Understand error filtering in catch

   PowerShell catch blocks can check error types to handle specific errors.

2. Step 2: Apply condition for missing file error

   Check if error is 'ItemNotFoundException' to show custom message only for missing files.

3. Final Answer:

   Use try-catch and check if the error is 'ItemNotFoundException' before showing custom message -> Option A

4. Quick Check:

   Filter error type in catch for custom message = B [OK]

Hint: Check error type in catch to customize messages [OK]

Common Mistakes:

• Showing same message for all errors
• Ignoring errors silently
• Not using catch block at all