ja-JP/about_CommonParameters.help.txt
|
TOPIC about_CommonParameters 簡単な説明 すべてのコマンドレットで使用できる共通パラメーターについて 説明します。 詳細な説明 共通パラメーターは、どのコマンドレットでも使用できるパラメーターの 集まりです。これらは PowerShell 自身によって実装されており、各 コマンドレットの開発者が個別に実装するものではありません。コマンドを 記述するときに自動的に追加されます。 共通パラメーターは、CmdletBinding 属性または Parameter 属性を 使用するアドバンスト関数でも利用できます。共通パラメーターと同じ名前を 使って独自のパラメーターを作成することはできません。 共通パラメーターを指定しても、コマンドが対応するメッセージを生成する 場合にのみ効果があります。たとえば -Verbose パラメーターは、コマンド内に Write-Verbose の呼び出しがある場合にのみ詳細メッセージを表示します。 共通パラメーターの一覧 次の共通パラメーターが利用できます。括弧内は別名（エイリアス）です。 -Debug (db) プログラマー向けの詳細な情報を表示します。このパラメーターは、 コマンドが Write-Debug でデバッグメッセージを生成する場合にのみ 効果があります。 -ErrorAction (ea) 非終了エラーに対する応答方法を指定します。$ErrorActionPreference 変数の値を、現在のコマンドに限り上書きします。 -ErrorVariable (ev) コマンドのエラーレコードを指定した変数に格納します。変数名の前に プラス記号（+）を付けると、既存の内容を上書きせずに追加します。 -InformationAction (infa) 情報ストリームのメッセージに対する応答方法を指定します。 $InformationPreference 変数の値を上書きします。 -InformationVariable (iv) 情報レコードを指定した変数に格納します。 -OutBuffer (ob) 次のコマンドレットへオブジェクトを渡す前に、バッファーに蓄積する オブジェクトの数を指定します（整数値）。 -OutVariable (ov) コマンドの出力オブジェクトを指定した変数に格納します。この変数は System.Collections.ArrayList 型になります。プラス記号（+）で追加 できます。 -PipelineVariable (pv) パイプライン要素の現在の値を指定した変数に格納し、パイプラインの 後続のコマンドから参照できるようにします。この変数はパイプライン内に スコープが限定され、実行前にクリアされます。Sort-Object のような ブロッキングコマンドの影響を受けます。 -ProgressAction (proga) 進行状況の更新に対する応答方法を指定します（PowerShell 7.4 で 追加）。$ProgressPreference 変数の値を上書きします。 -Verbose (vb) 操作に関する詳細な情報を表示します。$VerbosePreference 変数の値を 上書きします。このパラメーターは、コマンドが Write-Verbose で 詳細メッセージを生成する場合にのみ効果があります。 -WarningAction (wa) 警告に対する応答方法を指定します。$WarningPreference 変数の値を 上書きします。 -WarningVariable (wv) 警告レコードを指定した変数に格納します。 Action パラメーターの値 -ErrorAction、-WarningAction、-InformationAction、-ProgressAction の 各パラメーターには、次の値を指定できます。 Continue メッセージを表示して処理を続行します。多くのストリームの既定値です。 SilentlyContinue メッセージを表示せずに処理を続行します。 Stop メッセージを表示し、処理を停止します。 Inquire メッセージを表示し、続行するかどうかを確認します。 Ignore メッセージを抑制して続行します。$Error 変数にも追加しません。 Break 該当するメッセージが生成されたときにデバッガーに入ります。 Suspend ワークフロー専用です。PowerShell 6 以降では使用できません。 変数への追加 -ErrorVariable、-WarningVariable、-InformationVariable、-OutVariable で 変数名の前にプラス記号（+）を付けると、既存の変数の内容を上書きせず、 結果を追加できます。 # 既存の変数 $a にエラーを追加する Get-Process -Id 2 -ErrorVariable +a リスク軽減パラメーター 一部のコマンドレットは、データを変更したりリソースを大量に消費したり する操作に対して、次のリスク軽減パラメーターをサポートします。 -WhatIf (wi) コマンドを実行する代わりに、その操作によって何が起こるかを説明する メッセージを表示します。SwitchParameter 型です。 次のような出力になります。 # What if: Performing the operation "Remove File" on target # "C:\ps-test\date.csv". -Confirm (cf) コマンドを実行する前に確認を求めます。応答には次の選択肢があります。 [Y] はい (Yes) [A] すべてはい (Yes to All) [N] いいえ (No) [L] すべていいえ (No to All) [S] 中断 (Suspend) [?] ヘルプ (Help) Suspend を選ぶと、一時的な入れ子セッションが作成され、その中で 作業できます。元のコマンドに戻るには exit と入力します。 補足事項 非終了エラーとステートメント終了エラーには違いがあります。共通 パラメーターの効果はコマンドが該当するメッセージを生成する場合にのみ 現れます。共通パラメーターの値は、現在のコマンドに限って対応する 設定変数を上書きします。 関連項目 about_Preference_Variables about_Functions_Advanced about_Functions_CmdletBindingAttribute Write-Verbose Write-Debug Write-Error Write-Warning Write-Information ---- 原文: PowerShell-Docs (CC BY 4.0) の翻訳 / PSHelpJaJP |