Custom error messages in PowerShell

Introduction

Custom error messages help you understand what went wrong in your script in a clear and friendly way.

When you want to tell the user exactly why a command failed.

When you want to stop the script and explain the problem clearly.

When you want to check if a file exists and show a message if it doesn't.

When you want to handle mistakes in user input with a helpful message.

When you want to log errors with specific details for later review.

Syntax

PowerShell

try {
    # Code that might cause an error
} catch {
    Write-Error "Custom error message here"
}

The try block contains code that might fail.

The catch block runs if there is an error and shows your custom message.

Examples

This tries to get a file. If it doesn't exist, it shows a custom message.

PowerShell

try {
    Get-Item 'C:\nonexistentfile.txt'
} catch {
    Write-Error "File not found. Please check the path."
}

This tries to convert text to a number. If it fails, it shows a clear message.

PowerShell

try {
    $number = [int]"abc"
} catch {
    Write-Error "Invalid number format. Please enter digits only."
}

Sample Program

This script tries to divide 10 by zero, which causes an error. The catch block shows a friendly message. Then the script continues.

PowerShell

try {
    # Try to divide by zero to cause an error
    $result = 10 / 0
} catch {
    Write-Error "Oops! Division by zero is not allowed."
}

Write-Output "Script continues after handling the error."

Important Notes

Use Write-Error to show error messages in red text.

You can also use throw to stop the script with a custom error.

Always test your error messages to make sure they are clear and helpful.

Summary

Custom error messages make your scripts easier to understand.

Use try and catch blocks to handle errors gracefully.

Write clear and friendly messages to help users fix problems.

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