Write-Error

Write-Error
    [-Message] <string>
    [-Category <ErrorCategory>]
    [-ErrorId <string>]
    [-TargetObject <Object>]
    [-RecommendedAction <string>]
    [-CategoryActivity <string>]
    [-CategoryReason <string>]
    [-CategoryTargetName <string>]
    [-CategoryTargetType <string>]
    [<CommonParameters>]

Write-Error
    [-Exception] <Exception>
    [-Message <string>]
    [-Category <ErrorCategory>]
    [-ErrorId <string>]
    [-TargetObject <Object>]
    [-RecommendedAction <string>]
    [-CategoryActivity <string>]
    [-CategoryReason <string>]
    [-CategoryTargetName <string>]
    [-CategoryTargetType <string>]
    [<CommonParameters>]

Write-Error
    [-ErrorRecord] <ErrorRecord>
    [-RecommendedAction <string>]
    [-CategoryActivity <string>]
    [-CategoryReason <string>]
    [-CategoryTargetName <string>]
    [-CategoryTargetType <string>]
    [<CommonParameters>]

Write-Error コマンドレットは、終了しないエラーを宣言します。 既定では、エラーはエラー ストリーム内で、表示されるホスト プログラムに出力と共に送信されます。

終了しないエラーを書き込むには、エラー メッセージ文字列、ErrorRecord オブジェクト、または Exception オブジェクトを入力します。 エラー レコードを設定するには、Write-Error の他のパラメーターを使用します。

終了しないエラーはエラー ストリームにエラーを書き込みますが、コマンド処理は停止しません。 入力項目のコレクション内の 1 つの項目で終了しないエラーが宣言されている場合、コマンドは引き続きコレクション内の他の項目を処理します。

終了エラーを宣言するには、throw キーワードを使用します。 詳細については、about_Throwを参照してください。

Get-ChildItem | ForEach-Object {
    if ($_.GetType().ToString() -eq "Microsoft.Win32.RegistryKey")
    {
        Write-Error "Invalid object" -ErrorId B1 -TargetObject $_
    }
    else
    {
        $_
    }
}

このコマンドは、Get-ChildItem コマンドレットが powerShell レジストリ プロバイダーの Microsoft.Win32.RegistryKey または HKLM: ドライブ内のオブジェクトなどの HKCU: オブジェクトを返すときに、終了しないエラーを宣言します。

Write-Error "Access denied."

このコマンドは、終了しないエラーを宣言し、"アクセス拒否" エラーを書き込みます。 このコマンドでは、Message パラメーターを使用してメッセージを指定しますが、省略可能な Message パラメーター名は省略します。

Write-Error -Message "Error: Too many input values." -Category InvalidArgument

このコマンドは、終了しないエラーを宣言し、エラー カテゴリを指定します。

$E = [System.Exception]@{Source="Get-ParameterNames.ps1";HelpLink="https://go.microsoft.com/fwlink/?LinkID=113425"}
Write-Error -Exception $E -Message "Files not found. The $Files location doesn't contain any XML files."

このコマンドは、Exception オブジェクトを使用して、終了しないエラーを宣言します。

最初のコマンドでは、ハッシュ テーブルを使用して、System.Exception オブジェクトを作成します。 例外オブジェクトを $E 変数に保存します。 ハッシュ テーブルを使用して、null コンストラクターを持つ型の任意のオブジェクトを作成できます。

2 番目のコマンドでは、Write-Error コマンドレットを使用して、終了しないエラーを宣言します。 Exception パラメーターの値は、 変数の $E オブジェクトです。

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

エラー メッセージを含む文字列をこのコマンドレットにパイプできます。

このコマンドレットは出力を返しません。 エラー メッセージ ストリームにのみ書き込まれます。

Write-Error は、$? 自動変数の値を変更しないため、終了エラー状態を通知しません。 終了エラーを通知するには、$PSCmdlet.WriteError() メソッドを使用します。