エラー処理

try~catch~finally / 自動変数の$?と$ErrorActionPreference / trap / throw

try～catch～finallyステートメント

try～catch～finallyステートメントで、エラー処理ができます。

構文

try {
    <statement list>
}
catch [[<error type>][',' <error type>]*] {
    <statement list>
}
finally {
    <statement list>
}

Sample Script

script.ps1

try {
    Write-Host 'try'
    aaa
}
catch {
    Write-Host 'catch'
    Write-Host $_
}
finally {
    Write-Host 'finally'
}

実行例

PS C:\Users\user\Desktop> .\script.ps1
try
catch
用語 'aaa' は、コマンドレット、関数、スクリプト ファイル、または操作可能なプログラ
ムの名前として認識されません。名前が正しく記述されていることを確認し、パスが含まれ 
ている場合はそのパスが正しいことを確認してから、再試行してください。
finally

エラーの情報のアクセス方法

エラー内容やエラー箇所については、
$_や$PSItem、$_.ScriptStackTraceなどで確認でます。

scriptと実行例

script

script.ps1

$ErrorActionPreference = "Stop"
try {
    Write-Host "Main:try"
    Get-Content no_exist.txt # 存在しないファイルを開く
}
catch {
    Write-Host "Main:catch"

    Write-Host '$_:' $_
    Write-Host '$PSItem:' $PSItem

    Write-Host '$_.ScriptStackTrace:'
    Write-Host $_.ScriptStackTrace
}

実行例

PS /Users/user/Desktop> ./script.ps1
Main:try
Main:catch
$_: Cannot find path '/Users/user/Desktop/no_exist.txt' because it does not exist.
$PSItem: Cannot find path '/Users/user/Desktop/no_exist.txt' because it does not exist.
$_.ScriptStackTrace:
at <ScriptBlock>, /Users/user/Desktop/script.ps1: line 4
at <ScriptBlock>, <No file>: line 1

コマンドレットのエラー制御を指定する

$ErrorActionPreferenceに値を設定することで、エラー発生時の挙動を指定できます。
PowerShellには、下記の表の通り、終了するエラーと終了しないエラーがあります。

値	挙動
Continue	エラーを表示して、継続する。デフォルト値。
SilentlyContinue	エラーを表示しないで、継続する
Ignore	SilentlyContinueと同様。しかし、$error配列にエラー内容を追記しない
Inquire	ユーザーに対し確認プロンプトを表示する
Stop	エラー発生時点で、処理を停止する

終了するエラーはcatchされます。
一方、ContinueやSilentlyContinueはcatchされません。

上記のSample Scriptでは、
先頭行で$ErrorActionPreferenceをStopにすることで、
エラーをcatchできるようにしています。

対象のコマンドレットのエラー制御を指定する -ErrorAction

全体のエラー制御ではなく、
対象のコマンドレットのエラーを制御したい場合は「-ErrorAction」で指定します。
「-ea」という風に省略することもも可能です。

こんな場合に便利

スクリプトの規模が大きい時に、
全部のエラーはcatchしたくないが部分的なエラーをcatchしたい場合などに便利です。

Example

PS C:\Users\user\Desktop> cat no_exist.txt
cat : Cannot find path 'C:\Users\user\Desktop\no_exist.txt' because it does not exist.
At line:1 char:1
+ cat no_exist.txt
+ ~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (C:\Users\user\Desktop\no_exist.txt:String) [Get-Content], ItemNotFoundException
    + FullyQualifiedErrorId : PathNotFound,Microsoft.PowerShell.Commands.GetContentCommand
 
PS C:\Users\user\Desktop> cat no_exist.txt -ErrorAction SilentlyContinue
PS C:\Users\user\Desktop>
PS C:\Users\user\Desktop> cat no_exist.txt -ea SilentlyContinue
PS C:\Users\user\Desktop>

trapステートメント

PowerShell V1の頃からあります。

PowerShell V2でtry～catch～finallyステートメントが追加されたため、
trapステートメントを使用する機会は少ないかもしれません。

構文

trap [[<error type>]] {
    <statement list>
}

trapステートメント内にbreakをいれるかcontinueをいれるかで、挙動を指定できます。

どちらもなし：エラーを表示して、処理を継続する
break：エラーを表示して、処理を終了する
continue：エラーを表示しないで、処理を継続する

breakもcontinueもない場合

Script

Write-Host "Pre"
no_exist_command
Write-Host "Post"
 
trap {
    Write-Host "Trap"
}

実行結果

エラーを表示して処理を継続する。

PS C:\Users\user\Desktop> .\script.ps1
Pre
Trap
no_exist_command : The term 'no_exist_command' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the n
ame, or if a path was included, verify that the path is correct and try again.
At C:\Users\user\Desktop\script.ps1:2 char:1
+ no_exist_command
+ ~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (no_exist_command:String) [], CommandNotFoundException
    + FullyQualifiedErrorId : CommandNotFoundException
 
Post

breakの場合

Script

Write-Host "Pre"
no_exist_command
Write-Host "Post"
 
trap {
    Write-Host "Trap"
    break # 変更点
}

実行結果

エラーを表示して、処理を終了する。

PS C:\Users\user\Desktop> .\script.ps1
Pre
Trap
The term 'no_exist_command' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path was included, verify that the path is correct and try again.
At C:\Users\user\Desktop\script.ps1:2 char:1
+ no_exist_command
+ ~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (no_exist_command:String) [], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : CommandNotFoundException

continueの場合

Script

Write-Host "Pre"
no_exist_command
Write-Host "Post"
 
trap {
    Write-Host "Trap"
    continue # 変更点
}

実行結果

エラーを表示しないで、処理を継続する。

PS C:\Users\user\Desktop> .\script.ps1
Pre
Trap
Post

Visual Studio Codeでも、以下の違いがあるようです。

try～catch～finallyステートメントは、入力支援される
trapステートメントは、入力支援されない

エラーを発生させるthrow

エラーのthrow

PS> throw "Error!" # エラーメッセージを表示させる
Error!
At line:1 char:1

PS> throw New-Object System.NullReferenceException # 指定のエラーを発生させる
オブジェクト参照がオブジェクト インスタンスに設定されていません。
At line:1 char:1

エラーの再throw

下位関数内のcatchの中でthrowすると、上位の関数のcatchにエラーを渡すことができます。

function Sub {
    try {
        Write-Host "Sub :try"
        throw (Get-Date).ToString("yyyy/MM")    # 最初のthrow
    }
    catch {
        Write-Host "Sub :catch"
        throw    # 再throw
    }
}
 
function Main {
    try {
        Write-Host "Main:try"
        Sub
    }
    catch {
        Write-Host "Main:catch"
        Write-Host $_    # 受け取ったエラーを出力する
    }
    finally {
        Write-Host "Main:finally"
    }
}
 
Main

PS C:\Users\user\Desktop> .\script.ps1
Main:try
Sub :try  
Sub :catch
Main:catch
2020/11   
Main:finally

再throwには、throwがオススメ。
再throw時にthrow "Error Message"などとすると、エラーの個数（$error.Count）が余分に1つ増えてしまうのでやめたほうが良いかもしれません。

stackoverflow How can I Rethrow an exception from catch block in Powershell?