PowerShellにおける$Error変数とエラーハンドリングオプション(-ErrorAction, -ErrorVariable)の徹底解説

PowerShellは、Windows環境でのシステム管理や自動化のために非常に強力なツールです。

しかし、スクリプトやコマンドレットを実行する際にエラーが発生することは避けられません。

エラーハンドリングを適切に行うことで、スクリプトの信頼性と安定性を向上させることができます。

本記事では、PowerShellでエラーハンドリングを効果的に行う方法について詳しく解説します。

ErrorActionの使用

コマンドレット実行時にエラーハンドリングを細かく制御するために、ErrorActionとErrorVariableパラメーターを使用することができます。

ErrorActionは、エラーが発生した際のアクションを指定します。

主なオプションは以下の通りです。

Continue(デフォルト)

  • 概要: エラーが発生しても、メッセージを表示しつつスクリプトの実行を続行します。
  • 用途: 一般的なエラーハンドリングで、エラーが発生してもスクリプトを中断せずに続行したい場合に使用します。

SilentlyContinue

  • 概要: エラーが発生しても、エラーメッセージを表示せずにスクリプトの実行を続行します。
  • 用途: エラーメッセージをユーザーに表示したくない場合や、エラーが予想されるがスクリプトを中断したくない場合に使用します。

Stop

  • 概要: エラーが発生すると、スクリプトの実行を停止します。
  • 用途: 致命的なエラーが発生した場合にスクリプトの実行を中断したい場合や、エラーが発生した場合に特定の処理を行いたい場合に使用します。

Inquire

  • 概要: エラーが発生すると、ユーザーに対して実行を続行するか停止するかを問い合わせます。
  • 用途: エラーが発生した場合にユーザーの判断を仰ぎたい場合に使用します。対話的なスクリプトで便利です。

Ignore

  • 概要: エラーが発生しても、エラーメッセージを表示せず、エラーハンドリングも行わずにスクリプトの実行を続行します。
  • 用途: エラーを完全に無視してスクリプトを続行したい場合に使用しますが、通常は推奨されません。特別な理由がある場合にのみ使用します。
# 使用例

# 存在しないファイルの削除を試みる
Remove-Item "C:\nonexistentfile.txt" -ErrorAction SilentlyContinue

# 続けて他の操作を実行
Write-Host "スクリプトは継続しています。"

ErrorVariableの使用

-ErrorVariableとは

-ErrorVariableは、コマンドレットがエラーを検出した際、そのエラー情報を格納するためのカスタム変数を指定するオプションです。

デフォルトでは$Errorにエラーが格納されますが、-ErrorVariableを使うことで、他の変数にエラー情報を保存できます。

-ErrorVariableの使用方法

次の例では、Get-Contentコマンドが存在しないファイルを読み込もうとした場合に発生するエラーを、$myErrorという変数に保存します。

# 存在しないファイルを読み込む
Get-Content "C:\nonexistentfile.txt" -ErrorVariable myError

# エラー内容を確認
$myError

このように、エラーハンドリングの際に$Error以外の変数にエラー情報を保存することで、より柔軟なエラーハンドリングが可能になります。

-ErrorVariableと-ErrorActionの組み合わせ

-ErrorActionと-ErrorVariableは一緒に使うことも多いです。

例えば、次のようにエラーを無視しつつ、エラー情報は別の変数に保存できます。

# ファイルの削除を試みるがエラーメッセージは表示しない
Remove-Item "C:\nonexistentfile.txt" -ErrorAction SilentlyContinue -ErrorVariable myError

# エラー情報は$myErrorに保存されている
$myError

$Error変数

$Error変数の役割

PowerShellでは、エラーが発生するたびに、その情報が$Errorという変数に格納されます。

この変数はグローバル変数であり、スクリプト内のどこからでもアクセス可能です。

$Error変数は、エラーの発生履歴を持つリストとして機能し、最新のエラーがリストの最初に追加されます。

これを使うことで、エラーメッセージやエラーの詳細を後で確認することができます。

$Errorの基本操作

$Error変数はリスト形式であり、次のように操作できます。

# 最新のエラーを確認する
$Error[0]

# エラー数
$Error.Count

# エラー履歴の全体を確認する
$Error

$Errorのクリア

$Error変数は手動でクリアすることも可能です。

これにより、次にエラーが発生した際に不要な過去のエラー情報に惑わされることを防げます。

# $Errorをクリアする
$Error.Clear()

まとめ

PowerShellでのエラーハンドリングは、スクリプトの安定性と信頼性を向上させるための重要なスキルです。

本記事で紹介した基本的な概念から高度なテクニックまでを駆使して、より堅牢なスクリプトを作成しましょう。

エラーハンドリングをマスターすることで、PowerShellの力を最大限に引き出すことができるでしょう。